gir_ffi 0.6.5 → 0.6.6

data/History.txt

@@ -1,3 +1,8 @@
+== 0.6.6 / 2013-08-05
+
+* Handle GArrays of booleans and structs
+* Improve handling of gbooleans
+
 == 0.6.5 / 2013-08-03
 
 * Handle inline arrays of structs

data/TODO.rdoc

@@ -34,10 +34,11 @@ hidden issues.
 (11:47:15 PM) ebassi: the rest is "nice to have"
 (11:47:37 PM) ebassi: oh, and probably GBinding - but that's just because I wrote it ;-)
 
-== Compatibility with all implementations.
+== Use FFI::DataConverter to automatically convert GObject types
 
-GirFFI is incompatible with Rubinius, but this is due to Rubinius' FFI
-implementation lagging behind the others.
+GirFFI now generates loads of Something.wrap(ptr) calls; Perhaps these can be
+replace by implementing to_native and from_native in ClassBase and including
+FFI::DataConverter.
 
 == See Also
 

data/lib/ffi-glib/array.rb

@@ -20,26 +20,41 @@ module GLib
       end
     end
 
-    def append_vals data
-      bytes = GirFFI::InPointer.from_array element_type, data
-      len = data.length
+    def append_vals ary
+      bytes = GirFFI::InPointer.from_array element_type, ary
+      len = ary.length
       Lib.g_array_append_vals(self, bytes, len)
       self
     end
 
     # Re-implementation of the g_array_index macro
     def index idx
-      ptr = @struct[:data].get_pointer(idx * get_element_size)
-      # FIXME: Does not work for class-like values of element_type.
-      GirFFI::ArgHelper.cast_from_pointer(element_type, ptr)
+      # TODO: Check idx < length
+      ptr = GirFFI::InOutPointer.new element_type, data + idx * get_element_size
+      case element_type
+      when :utf8
+        GirFFI::ArgHelper.ptr_to_utf8 ptr.to_value
+      when Symbol
+        ptr.to_value
+      else
+        element_type.wrap ptr.to_value
+      end
     end
 
     def each
-      @struct[:len].times.each do |idx|
+      length.times.each do |idx|
         yield index(idx)
       end
     end
 
+    def length
+      @struct[:len]
+    end
+
+    def data
+      @struct[:data]
+    end
+
     def get_element_size
       Lib.g_array_get_element_size self
     end
@@ -66,11 +81,8 @@ module GLib
 
     def self.calculated_element_size type
       ffi_type = GirFFI::TypeMap.type_specification_to_ffitype(type)
-      if ffi_type.is_a? Symbol
-        FFI.type_size(ffi_type)
-      else
-        ffi_type.size
-      end
+      # FIXME: Smell. Make struct ffi_types into DataConvertor?
+      FFI.type_size(ffi_type) rescue ffi_type.size
     end
 
     def calculated_element_size

data/lib/ffi-gobject/value.rb

@@ -104,7 +104,7 @@ module GObject
 
       def for_g_type g_type
         return nil if g_type == TYPE_NONE
-        self.new.init g_type
+        self.new.tap {|it| it.init g_type }
       end
     end
 

data/lib/gir_ffi-base.rb

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

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

@@ -0,0 +1,17 @@
+require 'ffi'
+
+module GLib
+  # Implementation of gboolean
+  class Boolean
+    extend FFI::DataConverter
+    native_type :int #FFI::Type::INT
+
+    def self.from_native value, context
+      value != 0 ? true : false
+    end
+
+    def self.to_native value, context
+      value ? 1 : 0
+    end
+  end
+end

data/lib/gir_ffi.rb

@@ -1,12 +1,13 @@
 require 'ffi'
 
+require 'gir_ffi-base'
+
+require 'ffi-gobject_introspection'
+
 require 'gir_ffi/ffi_ext'
 require 'gir_ffi/class_base'
 require 'gir_ffi/type_map'
-
-require 'ffi-gobject_introspection'
 require 'gir_ffi/info_ext'
-
 require 'gir_ffi/in_pointer'
 require 'gir_ffi/in_out_pointer'
 require 'gir_ffi/zero_terminated'

data/lib/gir_ffi/ffi_ext/pointer.rb

@@ -13,18 +13,6 @@ module GirFFI
         # TODO: Move implementation here.
         ArgHelper.object_pointer_to_object self
       end
-
-      # XXX: int32 is size 4, bool is size 1. Why u no crash?
-      def put_bool offset, value
-        int = value ? 1 : 0
-        put_int32 offset, int
-      end
-
-      # XXX: int32 is size 4, bool is size 1. Why u no crash?
-      def get_bool offset
-        int = get_int32 offset
-        return (int != 0)
-      end
     end
   end
 end

data/lib/gir_ffi/in_out_pointer.rb

@@ -1,36 +1,70 @@
 module GirFFI
   # The InOutPointer class handles conversion between ruby types and
   # pointers for arguments with direction :inout and :out.
+  #
+  # TODO: This has now become a more general extende pointer class and should be renamed.
   class InOutPointer < FFI::Pointer
     attr_reader :value_type
 
-    def initialize value, type
-      @ffi_type = TypeMap.type_specification_to_ffitype type
+    def initialize type, ptr = nil
       @value_type = type
 
-      value = adjust_value_in value
-
-      ptr = AllocationHelper.safe_malloc(FFI.type_size @ffi_type)
-      ptr.send "put_#{@ffi_type}", 0, value
-
+      ptr ||= AllocationHelper.safe_malloc(value_type_size)
       super ptr
     end
 
     private :initialize
 
+    # TODO: Rename to get_value
     def to_value
-      self.send "get_#{@ffi_type}", 0
+      case value_ffi_type
+      when Class
+        to_ptr
+      when Symbol
+        adjust_value_out self.send("get_#{value_ffi_type}", 0)
+      else
+        raise NotImplementedError
+      end
     end
 
-    def self.for type
-      if Array === type
-        return self.new nil, *type
+    def set_value value
+      value = adjust_value_in value
+      case value_ffi_type
+      when Class
+        self.put_bytes 0, value.to_ptr.read_bytes(value_type_size), 0, value_type_size
+      when Symbol
+        self.send "put_#{value_ffi_type}", 0, value
+      else
+        raise NotImplementedError
       end
-      self.new nil, type
+    end
+
+    def value_ffi_type
+      @value_ffi_type ||= case value_type
+                          when :gboolean
+                            :int
+                          else
+                            TypeMap.type_specification_to_ffitype value_type
+                          end
+    end
+
+    def value_type_size
+      @value_type_size ||= case value_ffi_type
+                           when Class
+                             value_ffi_type.size
+                           when Symbol
+                             FFI.type_size value_ffi_type
+                           else
+                             raise NotImplementedError
+                           end
+    end
+
+    def self.for type
+      self.new(type).tap {|ptr| ptr.set_value nil}
     end
 
     def self.from type, value
-      self.new value, type
+      self.new(type).tap {|ptr| ptr.set_value value}
     end
 
     private
@@ -38,14 +72,23 @@ module GirFFI
     def adjust_value_in value
       case @value_type
       when :gboolean
-        value
+        value ? 1 : 0
       else
         value || nil_value
       end
     end
 
+    def adjust_value_out value
+      case value_type
+      when :gboolean
+        value != 0
+      else
+        value
+      end
+    end
+
     def nil_value
-      @ffi_type == :pointer ? nil : 0
+      value_ffi_type == :pointer ? nil : 0
     end
   end
 end

data/lib/gir_ffi/in_pointer.rb

@@ -8,6 +8,8 @@ module GirFFI
       case type
       when :utf8, :filename
         from_utf8_array ary
+      when :gboolean
+        from_boolean_array ary
       when Symbol
         from_basic_type_array type, ary
       when Class
@@ -47,6 +49,10 @@ module GirFFI
         from_basic_type_array :pointer, ptr_ary
       end
 
+      def from_boolean_array ary
+        from_basic_type_array :int, ary.map {|val| val ? 1 : 0}
+      end
+
       def from_interface_pointer_array ary
         ptr_ary = ary.map {|ifc| ifc.to_ptr}
         ptr_ary << nil

data/lib/gir_ffi/info_ext/i_signal_info.rb

@@ -65,6 +65,15 @@ module GirFFI
         end
         types.unshift(:pointer).push(:pointer)
       end
+
+      def return_ffi_type
+        result = super
+        if result == GLib::Boolean
+          :bool
+        else
+          result
+        end
+      end
     end
   end
 end

data/lib/gir_ffi/type_map.rb

@@ -18,7 +18,7 @@ module GirFFI
       :array => :pointer,
       :utf8 => :pointer,
       :GType => gtype_type,
-      :gboolean => :bool,
+      :gboolean => GLib::Boolean,
       :gunichar => :uint32,
       :gint8 => :int8,
       :guint8 => :uint8,

data/lib/gir_ffi/version.rb

@@ -1,3 +1,3 @@
 module GirFFI
-  VERSION = "0.6.5"
+  VERSION = "0.6.6"
 end

data/test/ffi-glib/array_test.rb

@@ -67,10 +67,15 @@ describe GLib::Array do
     assert_equal [1, 2, 3], arr.to_a
   end
 
-  describe "::from" do
-    it "creates a GArray from a Ruby array" do
+  describe ".from" do
+    it "creates a GArray from an array of :gint32" do
       arr = GLib::Array.from :gint32, [3, 2, 1]
-      assert_equal [3, 2, 1], arr.to_a
+      arr.data.read_array_of_int32(3).must_equal [3, 2, 1]
+    end
+
+    it "creates a GArray from an array of :gboolean" do
+      arr = GLib::Array.from :gboolean, [true, false, true]
+      arr.data.read_array_of_int(3).must_equal [1, 0, 1]
     end
 
     it "return its argument if given a GArray" do
@@ -119,5 +124,27 @@ describe GLib::Array do
       arr.wont_be :==, other
     end
   end
-end
 
+  describe "#index" do
+    it "returns the proper element for an array of :gint32" do
+      arr = GLib::Array.from :gint32, [1, 2, 3]
+      arr.index(2).must_equal 3
+    end
+
+    it "returns the proper element for an array of :utf8" do
+      arr = GLib::Array.from :utf8, ["a", "b", "c"]
+      arr.index(1).must_equal "b"
+    end
+
+    it "returns the proper element for an array of :gboolean" do
+      arr = GLib::Array.from :gboolean, [true, false, true]
+      arr.index(1).must_equal false
+    end
+
+    it "returns the proper element for an array of struct" do
+      vals = [1, 2, 3].map {|i| GObject::EnumValue.new.tap {|ev| ev.value = i} }
+      arr = GLib::Array.from GObject::EnumValue, vals
+      arr.index(1).value.must_equal 2
+    end
+  end
+end

data/test/gir_ffi-base/glib/boolean_test.rb

@@ -0,0 +1,27 @@
+require 'gir_ffi_test_helper'
+
+describe GLib::Boolean do
+  it "has the same native size as an int" do
+    FFI.type_size(GLib::Boolean).must_equal FFI.type_size :int
+  end
+
+  describe ".from_native" do
+    it "converts 0 to false" do
+      GLib::Boolean.from_native(0, "whatever").must_equal false
+    end
+
+    it "converts 1 to true" do
+      GLib::Boolean.from_native(1, "whatever").must_equal true
+    end
+  end
+
+  describe ".to_native" do
+    it "converts false to 0" do
+      GLib::Boolean.to_native(false, "whatever").must_equal 0
+    end
+
+    it "converts true to 1" do
+      GLib::Boolean.to_native(true, "whatever").must_equal 1
+    end
+  end
+end

data/test/gir_ffi/in_out_pointer_test.rb

@@ -3,6 +3,15 @@ require 'gir_ffi_test_helper'
 require 'gir_ffi/in_out_pointer'
 
 describe GirFFI::InOutPointer do
+  describe ".new" do
+    it "wraps an existing pointer and a type" do
+      ptr = GirFFI::AllocationHelper.safe_malloc(FFI.type_size(:int32))
+      ptr.put_int32 0, 42
+      instance = GirFFI::InOutPointer.new :gint32, ptr
+      instance.to_value.must_equal 42
+    end
+  end
+
   describe "an instance created with .from" do
     before do
       @result = GirFFI::InOutPointer.from :gint32, 23
@@ -18,8 +27,14 @@ describe GirFFI::InOutPointer do
   end
 
   describe ".from" do
-    it "handles :gboolean" do
-      GirFFI::InOutPointer.from :gboolean, false
+    it "handles :gboolean false" do
+      ptr = GirFFI::InOutPointer.from :gboolean, false
+      ptr.read_int.must_equal 0
+    end
+
+    it "handles :gboolean true" do
+      ptr = GirFFI::InOutPointer.from :gboolean, true
+      ptr.read_int.must_equal(1)
     end
 
     it "handles :utf8 pointers" do
@@ -42,7 +57,7 @@ describe GirFFI::InOutPointer do
     end
   end
 
-  describe "::for" do
+  describe ".for" do
     it "handles :gboolean" do
       GirFFI::InOutPointer.for :gboolean
     end
@@ -61,12 +76,12 @@ describe GirFFI::InOutPointer do
     describe "for :gboolean values" do
       it "works when the value is false" do
         ptr = GirFFI::InOutPointer.from :gboolean, false
-        assert_equal false, ptr.to_value
+        ptr.to_value.must_equal false
       end
 
       it "works when the value is true" do
         ptr = GirFFI::InOutPointer.from :gboolean, true
-        assert_equal true, ptr.to_value
+        ptr.to_value.must_equal true
       end
     end
 
@@ -77,5 +92,22 @@ describe GirFFI::InOutPointer do
         assert_equal "Some value", ptr.to_value.read_string
       end
     end
+
+    describe "for struct values" do
+      it "returns a pointer to the held value" do
+        val = GObject::EnumValue.new
+        val.value = 3
+        ptr = GirFFI::InOutPointer.from GObject::EnumValue, val
+        result = ptr.to_value
+        GObject::EnumValue.wrap(result).value.must_equal 3
+      end
+    end
+  end
+
+  describe "#value_ffi_type" do
+    it "returns :int for the :gboolean value type" do
+      ptr = GirFFI::InOutPointer.from :gboolean, true
+      ptr.value_ffi_type.must_equal :int
+    end
   end
 end

data/test/gir_ffi/info_ext/i_signal_info_test.rb

@@ -2,6 +2,7 @@ require 'gir_ffi_test_helper'
 
 describe GirFFI::InfoExt::ISignalInfo do
   let(:klass) { Class.new do
+    include GirFFI::InfoExt::ICallableInfo
     include GirFFI::InfoExt::ISignalInfo
   end }
   let(:signal_info) { klass.new }
@@ -55,4 +56,15 @@ describe GirFFI::InfoExt::ISignalInfo do
       end
     end
   end
+
+  describe "#return_ffi_type" do
+    # FIXME: This is needed because callbacks are limited in the accepted
+    # types. This should be fixed in FFI.
+    it "returns :bool for the :gboolean type" do
+      stub(return_type_info = Object.new).to_ffitype { GLib::Boolean }
+      stub(signal_info).return_type { return_type_info }
+
+      signal_info.return_ffi_type.must_equal :bool
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gir_ffi
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-03 00:00:00.000000000 Z
+date: 2013-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -170,6 +170,7 @@ files:
 - lib/gir_ffi/function_builder.rb
 - lib/gir_ffi-base/gir_ffi/library.rb
 - lib/gir_ffi-base/gobject/lib.rb
+- lib/gir_ffi-base/glib/boolean.rb
 - lib/gir_ffi-base/glib/strv.rb
 - lib/ffi-gobject/ruby_style.rb
 - lib/ffi-gobject/ruby_closure.rb
@@ -266,6 +267,7 @@ files:
 - test/gir_ffi/info_ext/i_field_info_test.rb
 - test/gir_ffi/info_ext/i_function_info_test.rb
 - test/gir_ffi/interface_base_test.rb
+- test/gir_ffi-base/glib/boolean_test.rb
 - test/gir_ffi-base/glib/strv_test.rb
 - test/ffi-gobject/object_class_test.rb
 - test/ffi-gobject/object_test.rb
@@ -358,6 +360,7 @@ test_files:
 - test/ffi-gobject_introspection/i_repository_test.rb
 - test/ffi-gobject_introspection/lib_test.rb
 - test/ffi-gobject_test.rb
+- test/gir_ffi-base/glib/boolean_test.rb
 - test/gir_ffi-base/glib/strv_test.rb
 - test/gir_ffi/arg_helper_test.rb
 - test/gir_ffi/argument_builder_test.rb