gir_ffi 0.5.2 → 0.6.0

data/lib/gir_ffi/info_ext/i_signal_info.rb

@@ -1,6 +1,7 @@
 module GirFFI
   module InfoExt
     # Extensions for GObjectIntrospection::ISignalInfo needed by GirFFI
+    # TODO: Rename methods to not include 'signal' everywhere.
     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.
@@ -10,7 +11,11 @@ module GirFFI
       # @return [FFI::Function] The signal handler, ready to be passed as a
       #   callback to C.
       def signal_callback &block
-        GirFFI::Builder.build_callback self, &signal_callback_args(&block)
+        rettype = self.return_ffi_type
+        argtypes = self.ffi_callback_argument_types
+
+        # TODO: Create signal handler type?
+        FFI::Function.new rettype, argtypes, &signal_callback_args(&block)
       end
 
       # TODO: Generate cast back methods using existing Argument builders.
@@ -36,7 +41,7 @@ module GirFFI
       def signal_arguments_to_gvalue_array instance, *rest
         arr = ::GObject::ValueArray.new self.n_args + 1
 
-        arr.append signal_reciever_to_gvalue instance
+        arr.append GObject::Value.wrap_instance(instance)
 
         self.args.zip(rest).each do |info, arg|
           arr.append info.argument_type.make_g_value.set_value(arg)
@@ -49,15 +54,17 @@ module GirFFI
         GObject::Value.for_g_type return_type.g_type
       end
 
-      private
-
-      def signal_reciever_to_gvalue instance
-        val = ::GObject::Value.new
-        val.init ::GObject.type_from_instance instance
-        val.set_instance instance
-        return val
+      # 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.argument_type.to_callback_ffitype
+        end
+        types.unshift(:pointer).push(:pointer)
       end
-
     end
   end
 end

data/lib/gir_ffi/info_ext/i_type_info.rb

@@ -21,12 +21,10 @@ module GirFFI
       end
 
       def layout_specification_type
-        ffitype = GirFFI::Builder.itypeinfo_to_ffitype self
+        ffitype = self.to_ffitype
         case ffitype
         when Class
           ffitype.const_get :Struct
-        when :bool
-          :int
         when :array
           subtype = param_type(0).layout_specification_type
           # XXX Don't use pointer directly to appease JRuby.
@@ -42,9 +40,9 @@ module GirFFI
       def element_type
         case tag
         when :glist, :gslist, :array
-          subtype_tag 0
+          subtype_tag_or_class 0
         when :ghash
-          [subtype_tag(0), subtype_tag(1)]
+          [subtype_tag_or_class(0), subtype_tag_or_class(1)]
         else
           nil
         end
@@ -54,24 +52,15 @@ module GirFFI
         interface.full_type_name
       end
 
-      def type_specification
-        tag = self.flattened_tag
-        case tag
-        when :strv, :zero_terminated, :c
-          "[#{tag.inspect}, #{subtype_tag_or_class_name}]"
-        else
-          tag.inspect
-        end
-      end
-
       def flattened_tag
-        case tag
+        type_tag = self.tag
+        case type_tag
         when :interface
           interface_type
         when :array
           flattened_array_type
         else
-          tag
+          type_tag
         end
       end
 
@@ -87,21 +76,71 @@ module GirFFI
         end
       end
 
-      def subtype_tag_or_class_name
-        type = self.param_type 0
-        tag = type.tag
-        base = if tag == :interface
-                 type.interface_type_name
+      def subtype_tag_or_class_name index = 0
+        param_type(index).tag_or_class_name
+      end
+
+      def subtype_tag_or_class index = 0
+        param_type(index).tag_or_class
+      end
+
+      # TODO: Merge with tag_or_class
+      def tag_or_class_name
+        type_tag = self.tag
+        base = if type_tag == :interface
+                 interface_type_name
                else
-                 tag.inspect
+                 type_tag.inspect
                end
-        if type.pointer? && tag != :utf8 && tag != :filename
+        if pointer? && type_tag != :utf8 && type_tag != :filename
           "[:pointer, #{base}]"
         else
           base
         end
       end
 
+      def tag_or_class
+        type_tag = self.tag
+        base = if type_tag == :interface
+                 Builder.build_class interface
+               else
+                 type_tag
+               end
+        if pointer? && type_tag != :utf8 && type_tag != :filename
+          [:pointer, base]
+        else
+          base
+        end
+      end
+
+      def to_ffitype
+        return :pointer if pointer?
+
+        type_tag = tag
+        if type_tag == :interface
+          Builder.build_class interface
+        else
+          TypeMap.map_basic_type type_tag
+        end
+      end
+
+      def to_callback_ffitype
+        type_tag = tag
+
+        return :string if type_tag == :utf8
+        return :pointer if pointer?
+
+        if type_tag == :interface
+          case interface.info_type
+          when :enum, :flags
+            :int32
+          else
+            :pointer
+          end
+        else
+          return TypeMap.map_basic_type type_tag
+        end
+      end
       private
 
       def zero_terminated_array_type
@@ -113,21 +152,6 @@ module GirFFI
           :zero_terminated
         end
       end
-
-      def subtype_tag index
-        st = param_type(index)
-        tag = st.tag
-        case tag
-        when :interface
-          return :interface_pointer if st.pointer?
-          return :interface
-        when :void
-          return :gpointer if st.pointer?
-          return :void
-        else
-          return tag
-        end
-      end
     end
   end
 end

data/lib/gir_ffi/info_ext.rb

@@ -1,8 +1,10 @@
-require 'gir_ffi/info_ext/safe_constant_name'
-require 'gir_ffi/info_ext/safe_function_name'
 require 'gir_ffi/info_ext/i_arg_info'
+require 'gir_ffi/info_ext/i_callable_info'
 require 'gir_ffi/info_ext/i_field_info'
+require 'gir_ffi/info_ext/i_function_info'
 require 'gir_ffi/info_ext/i_property_info'
-require 'gir_ffi/info_ext/i_signal_info'
 require 'gir_ffi/info_ext/i_registered_type_info'
+require 'gir_ffi/info_ext/i_signal_info'
 require 'gir_ffi/info_ext/i_type_info'
+require 'gir_ffi/info_ext/safe_constant_name'
+require 'gir_ffi/info_ext/safe_function_name'

data/lib/gir_ffi/null_argument_builder.rb

@@ -1,7 +1,7 @@
 module GirFFI
   # Argument builder that does nothing. Implements the Null Object pattern.
   class NullArgumentBuilder
-    def initialize *args; end
+    def initialize *; end
     def pre; []; end
     def post; []; end
     def callarg; end

data/lib/gir_ffi/return_value_builder.rb

@@ -9,18 +9,8 @@ module GirFFI
     end
 
     def post
-      if needs_wrapping?
-        if [ :interface, :object ].include?(specialized_type_tag) && @is_constructor
-          [ "#{retname} = self.constructor_wrap(#{cvar})" ]
-        else
-          [ "#{retname} = #{argument_class_name}.wrap(#{return_value_conversion_arguments})" ]
-        end
-      elsif specialized_type_tag == :utf8
-        # TODO: Re-use methods in InOutPointer for this conversion
-        [ "#{retname} = GirFFI::ArgHelper.ptr_to_utf8(#{cvar})" ]
-      elsif specialized_type_tag == :c
-        size = array_size
-        [ "#{retname} = GirFFI::ArgHelper.ptr_to_typed_array #{subtype_tag_or_class_name}, #{cvar}, #{size}" ]
+      if has_conversion?
+        [ "#{retname} = #{post_conversion}" ]
       else
         []
       end
@@ -47,6 +37,24 @@ module GirFFI
 
     private
 
+    def post_conversion
+      raw = cvar
+
+      if needs_constructor_wrap?
+        "self.constructor_wrap(#{raw})"
+      elsif needs_wrapping?
+        "#{argument_class_name}.wrap(#{conversion_arguments raw})"
+      else
+        case specialized_type_tag
+        when :utf8
+          # TODO: Re-use methods in InOutPointer for this conversion
+          "GirFFI::ArgHelper.ptr_to_utf8(#{raw})"
+        when :c
+          "GLib::SizedArray.wrap(#{subtype_tag_or_class_name}, #{array_size}, #{raw})"
+        end
+      end
+    end
+
     def retname
       @retname ||= @var_gen.new_var
     end
@@ -61,12 +69,12 @@ module GirFFI
       ].include?(specialized_type_tag)
     end
 
-    def is_void_return_value?
-      specialized_type_tag == :void && !type_info.pointer?
+    def needs_constructor_wrap?
+      @is_constructor && [ :interface, :object ].include?(specialized_type_tag)
     end
 
-    def return_value_conversion_arguments
-      conversion_arguments cvar
+    def is_void_return_value?
+      specialized_type_tag == :void && !type_info.pointer?
     end
   end
 end

data/lib/gir_ffi/unintrospectable_type_info.rb

@@ -0,0 +1,41 @@
+module GirFFI
+  # Represents a type not found in the GIR, conforming, as needed, to the
+  # interface of GObjectIntrospection::IObjectInfo.
+  class UnintrospectableTypeInfo
+    attr_reader :g_type
+
+    def initialize(gtype,
+                   gir = GObjectIntrospection::IRepository.default,
+                   gobject = ::GObject)
+      @g_type = gtype
+      @gir = gir
+      @gobject = gobject
+    end
+
+    def info_type
+      :unintrospectable
+    end
+
+    def safe_name
+      @gobject.type_name @g_type
+    end
+
+    def parent
+      @gir.find_by_gtype @gobject.type_parent(@g_type)
+    end
+
+    def namespace
+      parent.namespace
+    end
+
+    def interfaces
+      @gobject.type_interfaces(@g_type).map do |gtype|
+        @gir.find_by_gtype gtype
+      end.compact
+    end
+
+    def fields
+      []
+    end
+  end
+end

data/lib/gir_ffi/user_defined_property_info.rb

@@ -0,0 +1,15 @@
+module GirFFI
+  # Represents a property of a user defined type, conforming, as needed, to the
+  # interface of GObjectIntrospection::IPropertyInfo.
+  class UserDefinedPropertyInfo
+    def initialize param_spec
+      @param_spec = param_spec
+    end
+
+    attr_reader :param_spec
+
+    def name
+      @param_spec.get_name
+    end
+  end
+end

data/lib/gir_ffi/user_defined_type_info.rb

@@ -0,0 +1,25 @@
+require 'gir_ffi/user_defined_property_info'
+
+module GirFFI
+  # Represents a user defined type, conforming, as needed, to the interface of
+  # GObjectIntrospection::IObjectInfo.
+  class UserDefinedTypeInfo
+    def initialize klass, &block
+      @klass = klass
+      @properties = []
+      self.instance_eval(&block) if block
+    end
+
+    def described_class
+      @klass
+    end
+
+    def install_property property
+      @properties << UserDefinedPropertyInfo.new(property)
+    end
+
+    def properties
+      @properties
+    end
+  end
+end

data/lib/gir_ffi/version.rb

@@ -1,3 +1,3 @@
 module GirFFI
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/lib/gir_ffi-base.rb

@@ -1,2 +1,5 @@
+# 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/strv'
 require 'gir_ffi-base/gobject/lib'

data/lib/gir_ffi.rb

@@ -21,7 +21,8 @@ module GirFFI
   end
 
   def self.define_type klass, &block
-    Builder::Type::UserDefined.new(klass, &block).build_class
+    info = UserDefinedTypeInfo.new(klass, &block)
+    Builder::Type::UserDefined.new(info).build_class
 
     klass.get_gtype
   end

data/test/ffi-glib/sized_array_test.rb

@@ -0,0 +1,87 @@
+require 'base_test_helper'
+
+describe GLib::SizedArray do
+  describe "::wrap" do
+    it "takes a type, size and pointer and returns a GLib::SizedArray wrapping them" do
+      mock(ptr = Object.new).null? { false }
+      sarr = GLib::SizedArray.wrap :gint32, 3, ptr
+      assert_instance_of GLib::SizedArray, sarr
+      assert_equal ptr, sarr.to_ptr
+      assert_equal 3, sarr.size
+      assert_equal :gint32, sarr.element_type
+    end
+
+    it "returns nil if the wrapped pointer is null" do
+      mock(ptr = Object.new).null? { true }
+      sarr = GLib::SizedArray.wrap :gint32, 3, ptr
+      sarr.must_be_nil
+    end
+  end
+
+  describe "#each" do
+    it "yields each element" do
+      ary = ["one", "two", "three"]
+      ptrs = ary.map {|a| FFI::MemoryPointer.from_string(a)}
+      ptrs << nil
+      block = FFI::MemoryPointer.new(:pointer, ptrs.length)
+      block.write_array_of_pointer ptrs
+
+      sarr = GLib::SizedArray.new :utf8, 3, block
+      arr = []
+      sarr.each do |str|
+        arr << str
+      end
+      assert_equal ["one", "two", "three"], arr
+    end
+  end
+
+  describe "::from" do
+    context "from a Ruby array" do
+      it "creates a GLib::SizedArray with the same elements" do
+        arr = GLib::SizedArray.from :gint32, 3, [3, 2, 1]
+        arr.must_be_instance_of GLib::SizedArray
+        assert_equal [3, 2, 1], arr.to_a
+      end
+
+      it "raises an error if the array has the wrong number of elements" do
+        lambda { GLib::SizedArray.from :gint32, 4, [3, 2, 1] }.must_raise ArgumentError
+      end
+
+      it "uses the array's size if passed -1 as the size" do
+        arr = GLib::SizedArray.from :gint32, -1, [3, 2, 1]
+        arr.size.must_equal 3
+      end
+    end
+
+    context "from a GLib::SizedArray" do
+      it "return its argument" do
+        arr = GLib::SizedArray.from :gint32, 3, [3, 2, 1]
+        arr2 = GLib::SizedArray.from :gint32, 3, arr
+        assert_equal arr, arr2
+      end
+
+      it "raises an error if the argument has the wrong number of elements" do
+        arr = GLib::SizedArray.from :gint32, 3, [3, 2, 1]
+        lambda { GLib::SizedArray.from :gint32, 4, arr }.must_raise ArgumentError
+      end
+    end
+
+    it "returns nil when passed nil" do
+      arr = GLib::SizedArray.from :gint32, 0, nil
+      arr.must_be_nil
+    end
+
+    it "wraps its argument if given a pointer" do
+      arr = GLib::SizedArray.from :gint32, 3, [3, 2, 1]
+      arr2 = GLib::SizedArray.from :gint32, 3, arr.to_ptr
+      assert_instance_of GLib::SizedArray, arr2
+      refute_equal arr, arr2
+      assert_equal arr.to_a, arr2.to_a
+    end
+  end
+
+  it "includes Enumerable" do
+    GLib::SizedArray.must_include Enumerable
+  end
+end
+

data/test/ffi-gobject_introspection/i_base_info_test.rb

@@ -3,10 +3,6 @@ require 'introspection_test_helper'
 describe GObjectIntrospection::IBaseInfo do
   let(:described_class) { GObjectIntrospection::IBaseInfo }
   describe "#initialize" do
-    it "raises an error if nil is passed" do
-      proc { described_class.new nil }.must_raise ArgumentError
-    end
-
     it "raises an error if a null pointer is passed" do
       mock(ptr = Object.new).null? { true }
       proc { described_class.new ptr }.must_raise ArgumentError
@@ -21,7 +17,10 @@ describe GObjectIntrospection::IBaseInfo do
 
   describe "upon garbage collection" do
     it "calls g_base_info_unref" do
-      skip "cannot be reliably tested on JRuby" if RUBY_PLATFORM == 'java'
+      if defined?(RUBY_ENGINE) && ['jruby', 'rbx'].include?(RUBY_ENGINE)
+        skip "cannot be reliably tested on JRuby and Rubinius"
+      end
+
       mock(ptr = Object.new).null? { false }
       mock(lib = Object.new).g_base_info_unref(ptr) { nil }
       described_class.new ptr, lib