gir_ffi 0.5.2 → 0.6.0

data/History.txt

@@ -1,3 +1,8 @@
+== 0.6.0 / 2013-06-07
+
+* Support Rubinius
+* Lots of refactoring
+
 == 0.5.2 / 2013-04-23
 
 * Handle signal details in GObject.signal_connect and .signal_emit

data/lib/ffi-glib/array.rb

@@ -44,9 +44,8 @@ module GLib
     end
 
     def self.wrap elmttype, ptr
-      super(ptr).tap do |it|
-        break if it.nil?
-        it.element_type = elmttype
+      super(ptr).tap do |array|
+        array.element_type = elmttype if array
       end
     end
 

data/lib/ffi-glib/container_class_methods.rb

@@ -1,8 +1,8 @@
 module GLib
   module ContainerClassMethods
     def wrap typespec, ptr
-      if (it = super(ptr))
-        it.reset_typespec typespec
+      super(ptr).tap do |container|
+        container.reset_typespec typespec if container
       end
     end
 
@@ -13,6 +13,7 @@ module GLib
       when FFI::Pointer
         wrap typespec, it
       when self
+        # TODO: Reset or check?
         it.reset_typespec typespec
       else
         from_enumerable typespec, it
@@ -20,5 +21,3 @@ module GLib
     end
   end
 end
-
-

data/lib/ffi-glib/hash_table.rb

@@ -56,7 +56,9 @@ module GLib
     def self.hash_function_for keytype
       case keytype
       when :utf8
-        FFI::Function.new(:uint, [:pointer], find_support_funtion("g_str_hash"))
+        FFI::Function.new(:uint,
+                          [:pointer],
+                          find_support_function("g_str_hash"))
       else
         nil
       end
@@ -65,13 +67,15 @@ module GLib
     def self.equality_function_for keytype
       case keytype
       when :utf8
-        FFI::Function.new(:int, [:pointer, :pointer], find_support_funtion("g_str_equal"))
+        FFI::Function.new(:int,
+                          [:pointer, :pointer],
+                          find_support_function("g_str_equal"))
       else
         nil
       end
     end
 
-    def self.find_support_funtion name
+    def self.find_support_function name
       lib = ::GLib::Lib.ffi_libraries.first
       lib.find_function(name)
     end

data/lib/ffi-glib/list_methods.rb

@@ -46,7 +46,7 @@ module GLib
     end
 
     def next_element
-      return if @current.nil?
+      return if !@current
       element = @current.head
       @current = @current.tail
       element

data/lib/ffi-glib/sized_array.rb

@@ -0,0 +1,66 @@
+module GLib
+  # Class representing an array with a determined size
+  class SizedArray
+    include Enumerable
+    attr_reader :element_type, :size
+
+    def initialize element_type, size, pointer
+      @element_type = element_type
+      @size = size
+      @pointer = pointer
+    end
+
+    def to_ptr
+      @pointer
+    end
+
+    def each &block
+      # TODO: Move implementation from GirFFI::ArgHelper to here.
+      # While doing so, the implentation could also become a real iterator
+      arr = GirFFI::ArgHelper.ptr_to_typed_array(@element_type, @pointer, @size)
+      if block_given?
+        arr.each(&block)
+      else
+        arr.each
+      end
+    end
+
+    def self.wrap element_type, size, pointer
+      new element_type, size, pointer unless pointer.null?
+    end
+
+    class << self
+      def from element_type, size, item
+        return unless item
+
+        case item
+        when FFI::Pointer
+          wrap element_type, size, item
+        when self
+          from_sized_array size, item
+        else
+          from_enumerable element_type, size, item
+        end
+      end
+
+      private
+
+      def from_sized_array size, sized_array
+        check_size(size, sized_array.size)
+        sized_array
+      end
+
+      def from_enumerable element_type, size, arr
+        check_size(size, arr.size)
+        ptr = GirFFI::InPointer.from_array element_type, arr
+        self.wrap element_type, arr.size, ptr
+      end
+
+      def check_size(expected_size, size)
+        if expected_size > 0 && size != expected_size
+          raise ArgumentError, "Expected size #{expected_size}, got #{size}"
+        end
+      end
+    end
+  end
+end

data/lib/ffi-glib/strv.rb

@@ -1,5 +1,5 @@
 module GLib
-  # Extra methods for GLib::Strv.
+  # Extra methods for GLib::Strv. The bulk is defined in `gir_ffi-base/glib/strv.rb`
   class Strv
     def self.from it
       case it

data/lib/ffi-glib.rb

@@ -3,12 +3,13 @@
 
 GirFFI.setup :GLib
 
-require 'ffi-glib/s_list'
-require 'ffi-glib/list'
-require 'ffi-glib/hash_table'
-require 'ffi-glib/byte_array'
 require 'ffi-glib/array'
+require 'ffi-glib/byte_array'
+require 'ffi-glib/hash_table'
+require 'ffi-glib/list'
 require 'ffi-glib/ptr_array'
+require 'ffi-glib/s_list'
+require 'ffi-glib/sized_array'
 require 'ffi-glib/strv'
 
 module GLib

data/lib/ffi-gobject/object.rb

@@ -46,10 +46,9 @@ module GObject
     def adjust_value_to_type val, type
       case type.tag
       when :ghash
-        GLib::HashTable.from [type.param_type(0).tag, type.param_type(1).tag],
-          val
+        GLib::HashTable.from type.element_type, val
       when :glist
-        GLib::List.from type.param_type(0).tag, val
+        GLib::List.from type.element_type, val
       else
         val
       end

data/lib/ffi-gobject/ruby_closure.rb

@@ -37,8 +37,9 @@ module GObject
       return closure
     end
 
+    # TODO: Use invocation_hint and marshal_data
     def self.marshaller(closure, return_value, n_param_values,
-                        param_values, invocation_hint, marshal_data)
+                        param_values, _invocation_hint, _marshal_data)
       rclosure = wrap(closure.to_ptr)
 
       args = n_param_values.times.map {|idx|
@@ -47,7 +48,7 @@ module GObject
 
       result = rclosure.invoke_block(*args)
 
-      return_value.set_ruby_value(result) unless return_value.nil?
+      return_value.set_ruby_value(result) if return_value
     end
   end
 end

data/lib/ffi-gobject/value.rb

@@ -3,6 +3,7 @@ module GObject
 
   # Overrides for GValue, GObject's generic value container structure.
   class Value
+    # TODO: Give more generic name
     def set_ruby_value val
       if current_gtype == 0
         init_for_ruby_value val
@@ -25,8 +26,7 @@ module GObject
     }
 
     def set_value val
-      method = TYPE_TO_SET_METHOD_MAP[current_fundamental_type]
-      call_or_raise method, val
+      send set_method, val
       self
     end
 
@@ -70,12 +70,13 @@ module GObject
       TYPE_POINTER => :get_pointer
     }
 
+    # TODO: Rename to get_value
     def ruby_value
-      method = TYPE_TO_GET_METHOD_MAP[current_fundamental_type]
-      call_or_raise method
+      send get_method
     end
 
     class << self
+      # TODO: Give more generic name
       def wrap_ruby_value val
         self.new.set_ruby_value val
       end
@@ -97,15 +98,22 @@ module GObject
       end
     end
 
+    # TODO: Combine with wrap_ruby_value
+    def self.wrap_instance instance
+      self.new.tap {|it|
+        it.init GObject.type_from_instance instance
+        it.set_instance instance
+      }
+    end
+
     private
 
     def set_instance_enhanced val
-      check_type_compatibility val
+      check_type_compatibility val if val
       set_instance val
     end
 
     def check_type_compatibility val
-      return if val.nil?
       if !GObject::Value.type_compatible(GObject.type_from_instance(val), current_gtype)
         raise ArgumentError, "#{val.class} is incompatible with #{current_gtype_name}"
       end
@@ -113,22 +121,26 @@ module GObject
 
     def get_boxed_enhanced
       boxed = get_boxed
-      case current_gtype
+      gtype = current_gtype
+
+      case gtype
       when TYPE_STRV
         GLib::Strv.wrap boxed
       when TYPE_HASH_TABLE
         GLib::HashTable.wrap [:gpointer, :gpointer], boxed
       else
-        GirFFI::ArgHelper.wrap_object_pointer_by_gtype boxed, current_gtype
+        GirFFI::ArgHelper.wrap_object_pointer_by_gtype boxed, gtype
       end
     end
 
-    def call_or_raise method, *args
-      if method
-        send method, *args
-      else
-        raise "Don't know how to handle #{current_gtype_name}"
-      end
+    def get_method
+      TYPE_TO_GET_METHOD_MAP[current_fundamental_type] or
+        raise "Can't find method to get #{current_gtype_name}"
+    end
+
+    def set_method
+      TYPE_TO_SET_METHOD_MAP[current_fundamental_type] or
+        raise "Can't find method to set #{current_gtype_name}"
     end
   end
 end

data/lib/ffi-gobject.rb

@@ -61,15 +61,13 @@ module GObject
 
   def self.signal_emit object, detailed_signal, *args
     signal, detail = detailed_signal.split('::')
-    sig_info = object.class.find_signal signal
-
-    id = signal_lookup_from_instance signal, object
+    signal_id = signal_lookup_from_instance signal, object
     detail_quark = GLib.quark_from_string(detail)
-
+    sig_info = object.class.find_signal signal
     arr = sig_info.signal_arguments_to_gvalue_array object, *args
     rval = sig_info.gvalue_for_signal_return_value
 
-    Lib.g_signal_emitv arr.values, id, detail_quark, rval
+    Lib.g_signal_emitv arr.values, signal_id, detail_quark, rval
 
     return rval
   end
@@ -79,10 +77,13 @@ module GObject
     sig_info = object.class.find_signal signal
     callback = sig_info.signal_callback(&block)
     GirFFI::CallbackHelper.store_callback callback
+
     data_ptr = GirFFI::ArgHelper.object_to_inptr data
+
     Lib.g_signal_connect_data object, detailed_signal, callback, data_ptr, nil, 0
   end
 
+  # Smells of :reek:LongParameterList: due to the C interface.
   def self.param_spec_int(name, nick, blurb, minimum, maximum,
                           default_value, flags)
     ptr = Lib.g_param_spec_int(name, nick, blurb, minimum, maximum,
@@ -97,6 +98,8 @@ module GObject
   load_class :ParamFlags
 
   module Lib
+    # NOTE: This Lib module is set up in `gir_ffi-base/gobject/lib.rb`.
+
     attach_function :g_object_ref, [:pointer], :void
     attach_function :g_object_ref_sink, [:pointer], :void
     attach_function :g_object_unref, [:pointer], :void

data/lib/ffi-gobject_introspection/g_error.rb

@@ -1,6 +1,7 @@
 module GObjectIntrospection
   # Wraps GLib's GError struct.
   class GError
+    # GLib's GError struct.
     class Struct < FFI::Struct
       layout :domain, :uint32,
         :code, :int,

data/lib/ffi-gobject_introspection/i_base_info.rb

@@ -3,10 +3,11 @@ module GObjectIntrospection
   # Decendant types will be implemented as needed.
   class IBaseInfo
     def initialize ptr, lib=Lib
-      raise ArgumentError, "ptr must not be nil" if ptr.nil?
       raise ArgumentError, "ptr must not be null" if ptr.null?
 
-      ObjectSpace.define_finalizer self, self.class.make_finalizer(lib, ptr)
+      unless defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+        ObjectSpace.define_finalizer self, self.class.make_finalizer(lib, ptr)
+      end
 
       @gobj = ptr
       @lib = lib

data/lib/ffi-gobject_introspection/i_union_info.rb

@@ -1,22 +1,35 @@
 module GObjectIntrospection
   # Wraps a GIUnionInfo struct.
   # Represents a union.
-  # Not implemented yet.
   class IUnionInfo < IRegisteredTypeInfo
-    def n_fields; Lib.g_union_info_get_n_fields @gobj; end
-    def field(index); IFieldInfo.wrap(Lib.g_union_info_get_field @gobj, index); end
+    def n_fields
+      Lib.g_union_info_get_n_fields @gobj
+    end
+    def field(index)
+      IFieldInfo.wrap(Lib.g_union_info_get_field @gobj, index)
+    end
 
     ##
     build_array_method :fields
 
-    def get_n_methods; Lib.g_union_info_get_n_methods @gobj; end
-    def get_method(index); IFunctionInfo.wrap(Lib.g_union_info_get_method @gobj, index); end
+    def get_n_methods
+      Lib.g_union_info_get_n_methods @gobj
+    end
+    def get_method(index)
+      IFunctionInfo.wrap(Lib.g_union_info_get_method @gobj, index)
+    end
 
     ##
     build_array_method :get_methods
 
-    def find_method(name); IFunctionInfo.wrap(Lib.g_union_info_find_method @gobj, name); end
-    def size; Lib.g_union_info_get_size @gobj; end
-    def alignment; Lib.g_union_info_get_alignment @gobj; end
+    def find_method(name)
+      IFunctionInfo.wrap(Lib.g_union_info_find_method @gobj, name)
+    end
+    def size
+      Lib.g_union_info_get_size @gobj
+    end
+    def alignment
+      Lib.g_union_info_get_alignment @gobj
+    end
   end
 end

data/lib/ffi-gobject_introspection/lib.rb

@@ -233,6 +233,7 @@ module GObjectIntrospection
     attach_function :g_interface_info_get_constant, [:pointer, :int], :pointer
     attach_function :g_interface_info_get_iface_struct, [:pointer], :pointer
 
+    # Union type representing an argument value
     class GIArgument < FFI::Union
       signed_size_t = "int#{FFI.type_size(:size_t) * 8}".to_sym
 

data/lib/gir_ffi/argument_builder.rb

@@ -48,11 +48,13 @@ module GirFFI
         case specialized_type_tag
         when :enum, :flags
           "#{argument_class_name}[#{output_conversion_arguments}]"
+        when :utf8
+          "ArgHelper.ptr_to_utf8 #{callarg}.to_value"
         else
           "#{argument_class_name}.wrap(#{output_conversion_arguments})"
         end
       elsif is_fixed_length_array?
-        "#{callarg}.to_sized_array_value #{array_size}"
+        "GLib::SizedArray.wrap(#{subtype_tag_or_class_name}, #{array_size}, #{callarg}.to_value)"
       else
         "#{callarg}.to_value"
       end
@@ -91,9 +93,9 @@ module GirFFI
     def set_function_call_argument
       value = if @direction == :out
                 if is_caller_allocated_object?
-                  "#{argument_class_name}.allocate"
+                  "#{argument_class_name}._allocate"
                 else
-                  "GirFFI::InOutPointer.for #{type_specification}"
+                  "GirFFI::InOutPointer.for #{specialized_type_tag.inspect}"
                 end
               else
                 if needs_ingoing_parameter_conversion?
@@ -112,7 +114,7 @@ module GirFFI
 
     def needs_outgoing_parameter_conversion?
       [ :array, :enum, :flags, :ghash, :glist, :gslist, :object, :struct,
-        :strv ].include?(specialized_type_tag)
+        :strv, :utf8 ].include?(specialized_type_tag)
     end
 
     def needs_ingoing_parameter_conversion?
@@ -127,23 +129,13 @@ module GirFFI
         base = "#{argument_class_name}[#{parameter_conversion_arguments}]"
         "GirFFI::InOutPointer.from #{specialized_type_tag.inspect}, #{base}"
       when :object, :struct, :void, :glist, :gslist, :ghash, :array,
-        :zero_terminated, :strv, :callback
+        :zero_terminated, :strv, :callback, :utf8, :c
         base = "#{argument_class_name}.from(#{parameter_conversion_arguments})"
         if has_output_value?
-          if specialized_type_tag == :strv
-            "GirFFI::InOutPointer.from #{type_specification}, #{base}"
-          else
-            "GirFFI::InOutPointer.from :pointer, #{base}"
-          end
+          "GirFFI::InOutPointer.from :pointer, #{base}"
         else
           base
         end
-      when :c, :utf8
-        if has_output_value?
-          "GirFFI::InOutPointer.from #{parameter_conversion_arguments}"
-        else
-          "GirFFI::InPointer.from(#{parameter_conversion_arguments})"
-        end
       else
         base = "#{parameter_conversion_arguments}"
         "GirFFI::InOutPointer.from #{specialized_type_tag.inspect}, #{base}"
@@ -157,9 +149,5 @@ module GirFFI
     def parameter_conversion_arguments
       conversion_arguments @name
     end
-
-    def self_t
-      type_tag.inspect
-    end
   end
 end

data/lib/gir_ffi/base_argument_builder.rb

@@ -33,45 +33,30 @@ module GirFFI
       @typeinfo
     end
 
-    def type_tag
-      type_info.tag
-    end
-
     def specialized_type_tag
       type_info.flattened_tag
     end
 
-    def type_specification
-      type_info.type_specification
-    end
-
     TAG_TO_WRAPPER_CLASS_MAP = {
+      :array => 'GLib::Array',
+      :byte_array => 'GLib::ByteArray',
+      :c => 'GLib::SizedArray',
+      :callback => 'GirFFI::Callback',
+      :ghash => 'GLib::HashTable',
       :glist => 'GLib::List',
       :gslist => 'GLib::SList',
-      :ghash => 'GLib::HashTable',
-      :array => 'GLib::Array',
+      :ptr_array => 'GLib::PtrArray',
+      :strv => 'GLib::Strv',
       :utf8 => 'GirFFI::InPointer',
-      :void => 'GirFFI::InPointer'
+      :void => 'GirFFI::InPointer',
+      :zero_terminated => 'GirFFI::ZeroTerminated'
     }
 
+    # TODO: Use class rather than class name
     def argument_class_name
       case (tag = type_info.flattened_tag)
       when :struct, :union, :object, :interface, :enum, :flags
         type_info.interface_type_name
-      when :callback
-        'GirFFI::Callback'
-      when :byte_array
-        'GLib::ByteArray'
-      when :array
-        'GLib::Array'
-      when :ptr_array
-        'GLib::PtrArray'
-      when :strv
-        'GLib::Strv'
-      when :c
-        'GirFFI::InPointer'
-      when :zero_terminated
-        'GirFFI::ZeroTerminated'
       else
         TAG_TO_WRAPPER_CLASS_MAP[tag]
       end
@@ -130,11 +115,11 @@ module GirFFI
     def conversion_arguments name
       case specialized_type_tag
       when :utf8, :void
-        "#{self_t}, #{name}"
+        "#{specialized_type_tag.inspect}, #{name}"
+      when :c
+        "#{subtype_tag_or_class_name}, #{type_info.array_fixed_size}, #{name}"
       when :glist, :gslist, :ghash, :array, :zero_terminated
         "#{elm_t}, #{name}"
-      when :c
-        "#{type_specification}, #{name}"
       when :callback
         iface = type_info.interface
         "\"#{iface.namespace}\", \"#{iface.name}\", #{name}"
@@ -144,5 +129,3 @@ module GirFFI
     end
   end
 end
-
-

data/lib/gir_ffi/builder/module.rb

@@ -29,7 +29,8 @@ module GirFFI
       lib = modul.const_get(:Lib)
 
       Builder.attach_ffi_function lib, go
-      modul.class_eval function_definition(go, lib)
+      definition = function_definition(go, lib)
+      modul.class_eval definition
 
       true
     end
@@ -46,13 +47,6 @@ module GirFFI
     def build_module
       unless defined? @module
         build_dependencies
-        build_module_non_recursive
-      end
-      @module
-    end
-
-    def build_module_non_recursive
-      unless defined? @module
         instantiate_module
         setup_lib_for_ffi
         setup_module unless already_set_up
@@ -66,7 +60,7 @@ module GirFFI
       deps = gir.dependencies @namespace
       deps.each {|dep|
         name, version = dep.split '-'
-        Builder.build_module_non_recursive name, version
+        Builder.build_module name, version
       }
     end
 

data/lib/gir_ffi/builder/type/base.rb

@@ -1,3 +1,5 @@
+require 'gir_ffi/builder_helper'
+
 module GirFFI
   module Builder
     module Type

data/lib/gir_ffi/builder/type/callback.rb

@@ -18,11 +18,11 @@ module GirFFI
         end
 
         def argument_types
-          Builder.ffi_function_argument_types info
+          @info.argument_ffi_types
         end
 
         def return_type
-          Builder.ffi_function_return_type info
+          @info.return_ffi_type
         end
       end
     end

data/lib/gir_ffi/builder/type/enum.rb

@@ -1,4 +1,5 @@
 require 'gir_ffi/builder/type/registered_type'
+
 module GirFFI
   module Builder
     module Type

data/lib/gir_ffi/builder/type/object.rb

@@ -1,4 +1,6 @@
-require 'gir_ffi/builder/type/struct_based'
+require 'gir_ffi/builder/type/registered_type'
+require 'gir_ffi/builder/type/with_layout'
+require 'gir_ffi/builder/type/with_methods'
 require 'gir_ffi/builder/property'
 require 'gir_ffi/object_base'
 
@@ -7,7 +9,10 @@ module GirFFI
     module Type
 
       # Implements the creation of a class representing a GObject Object.
-      class Object < StructBased
+      class Object < RegisteredType
+        include WithMethods
+        include WithLayout
+
         def find_signal signal_name
           signal_definers.each do |inf|
             inf.signals.each do |sig|
@@ -46,10 +51,15 @@ module GirFFI
           setup_interfaces
         end
 
+        # FIXME: Private method only in subclass
+        def layout_superclass
+          FFI::Struct
+        end
+
         def parent
           unless defined? @parent
             pr = info.parent
-            if pr.nil? or (pr.name == @classname and pr.namespace == @namespace)
+            if pr.nil? or (pr.safe_name == @classname and pr.namespace == @namespace)
               @parent = nil
             else
               @parent = pr