gir_ffi 0.0.9 → 0.0.10

data/History.txt

@@ -1,3 +1,9 @@
+== 0.0.10 / 2011-05-18
+
+* Handle GObject interfaces properly.
+* Create types only defined by the GType system.
+* Support GType array return values.
+
 == 0.0.9 / 2011-05-02
 
 * More complete support for the basic types.

data/lib/gir_ffi/arg_helper.rb

@@ -1,5 +1,6 @@
 require 'gir_ffi/allocation_helper'
 require 'gir_ffi/builder'
+require 'gir_ffi/builder/dynamic_type'
 
 module GirFFI
   module ArgHelper
@@ -201,7 +202,7 @@ module GirFFI
     def self.outptr_to_int32_array ptr, size
       block = ptr.read_pointer
       return nil if block.null?
-      ptr_to_int32_array block, size
+      ptr_to_gint32_array block, size
     end
 
     # Converts an outptr to an array of the given class.
@@ -224,13 +225,18 @@ module GirFFI
       end
     end
 
-    def self.ptr_to_int32_array ptr, size
-      ptr.get_array_of_int32(0, size)
+    def self.setup_ptr_to_type_array_handler_for *types
+      types.flatten.each do |type|
+        ffi_type = GirFFI::Builder::TAG_TYPE_MAP[type] || type
+        defn =
+          "def self.ptr_to_#{type}_array ptr, size
+            ptr.get_array_of_#{ffi_type}(0, size)
+          end"
+        eval defn
+      end
     end
 
-    def self.ptr_to_int16_array ptr, size
-      ptr.get_array_of_int16(0, size)
-    end
+    setup_ptr_to_type_array_handler_for SIMPLE_G_TYPES
 
     def self.ptr_to_utf8_array ptr, size
       ptrs = ptr.read_array_of_pointer(size)
@@ -262,28 +268,15 @@ module GirFFI
       ptr.null? ? nil : ptr.read_string(len)
     end
 
-    class << self
-      alias ptr_to_int_array ptr_to_int32_array
-      alias ptr_to_gint32_array ptr_to_int32_array
-      alias ptr_to_gint16_array ptr_to_int16_array
-    end
-
     # Set up gtype handlers depending on type size.
     class << self
-      case FFI.type_size(:size_t)
-      when 4
-        alias gtype_array_to_inptr gint32_array_to_inptr
-        alias gtype_outptr gint32_outptr
-        alias gtype_to_inoutptr gint32_to_inoutptr
-        alias outptr_to_gtype outptr_to_gint32
-      when 8
-        alias gtype_array_to_inptr gint64_array_to_inptr
-        alias gtype_outptr gint64_outptr
-        alias gtype_to_inoutptr gint64_to_inoutptr
-        alias outptr_to_gtype outptr_to_gint64
-      else
-        raise RuntimeError, "Unexpected size of :size_t"
-      end
+      sz = FFI.type_size(:size_t) * 8
+      type = "guint#{sz}"
+      alias_method :gtype_array_to_inptr, "#{type}_array_to_inptr"
+      alias_method :gtype_outptr, "#{type}_outptr"
+      alias_method :gtype_to_inoutptr, "#{type}_to_inoutptr"
+      alias_method :outptr_to_gtype, "outptr_to_#{type}"
+      alias_method :ptr_to_gtype_array, "ptr_to_#{type}_array"
     end
 
     def self.outptr_strv_to_utf8_array ptr
@@ -436,7 +429,11 @@ module GirFFI
       return nil if optr.null?
       tp = ::GObject.type_from_instance_pointer optr
       info = gir.find_by_gtype tp
-      klass = GirFFI::Builder.build_class info
+      if info.nil?
+        klass = GirFFI::Builder::DynamicType.new(tp).build_class
+      else
+        klass = GirFFI::Builder.build_class info
+      end
       klass.wrap optr
     end
 

data/lib/gir_ffi/builder/argument.rb

@@ -658,9 +658,9 @@ module GirFFI::Builder
                 VoidReturnValue
               when :interface
                 case type.interface.info_type
-                when :interface, :struct, :union
+                when :struct, :union
                   InterfaceReturnValue
-                when :object
+                when :interface, :object
                   if arginfo.constructor?
                     ConstructorReturnValue
                   else

data/lib/gir_ffi/builder/dynamic_type.rb

@@ -0,0 +1,41 @@
+module GirFFI
+  module Builder
+    class DynamicType
+      CACHE = {}
+
+      def initialize gtype
+        @gtype = gtype
+      end
+
+      def build_class
+        CACHE[@gtype] ||= Class.new(parent).tap do |klass|
+          interfaces.each do |iface|
+            klass.class_eval do
+              include iface
+            end
+          end
+        end
+      end
+
+      private
+
+      def parent
+        parent_type = ::GObject.type_parent @gtype
+        info = gir.find_by_gtype(parent_type)
+        GirFFI::Builder.build_class info
+      end
+
+      def interfaces
+        iface_types = ::GObject.type_interfaces @gtype
+        iface_types.map do |gtype|
+          info = gir.find_by_gtype gtype
+          GirFFI::Builder.build_class info
+        end
+      end
+
+      def gir
+        @gir ||= GirFFI::IRepository.default
+      end
+    end
+  end
+end

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

@@ -4,7 +4,29 @@ module GirFFI
     module Type
 
       # Implements the creation of a class representing an Interface.
-      class Interface < StructBased
+      class Interface < RegisteredType
+        def build_class
+          unless defined? @klass
+            instantiate_module
+          end
+          @klass
+        end
+
+        def instantiate_module
+          @klass = optionally_define_constant(namespace_module, @classname) do
+            ::Module.new do
+              def self.gir_ffi_builder
+                const_get :GIR_FFI_BUILDER
+              end
+            end
+          end
+          setup_module unless already_set_up
+        end
+
+        def setup_module
+          setup_constants
+          stub_methods
+        end
       end
     end
   end

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

@@ -5,9 +5,42 @@ module GirFFI
 
       # Implements the creation of a class representing a GObject Object.
       class Object < StructBased
+        def setup_method method
+          if super
+            return true
+          else
+            if parent
+              return superclass.gir_ffi_builder.setup_method method
+            else
+              return false
+            end
+          end
+        end
+
+        def setup_instance_method method
+          if super
+            return true
+          else
+            info.interfaces.each do |ifinfo|
+              iface = GirFFI::Builder.build_class ifinfo
+              if iface.gir_ffi_builder.setup_instance_method method
+                return true
+              end
+            end
+            if parent
+              return superclass.gir_ffi_builder.setup_instance_method method
+            else
+              return false
+            end
+          end
+        end
+
+        private
+
         def setup_class
           super
           setup_vfunc_invokers
+          setup_interfaces
         end
 
         def parent
@@ -36,6 +69,15 @@ module GirFFI
           end
         end
 
+        def setup_interfaces
+          info.interfaces.each do |ifinfo|
+            iface = GirFFI::Builder.build_class ifinfo
+            @klass.class_eval do
+              include iface
+            end
+          end
+        end
+
         def signal_definers
           [info] + info.interfaces
         end

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

@@ -14,30 +14,12 @@ module GirFFI
           meta = (class << klass; self; end)
 
           go = method_introspection_data method
-          if go.nil?
-            if parent
-              return superclass.gir_ffi_builder.setup_method method
-            else
-              raise NoMethodError
-            end
-          end
-
           attach_and_define_method method, go, meta
         end
 
         def setup_instance_method method
           go = instance_method_introspection_data method
-          result = attach_and_define_method method, go, build_class
-
-          unless result
-            if parent
-              return superclass.gir_ffi_builder.setup_instance_method method
-            else
-              return false
-            end
-          end
-
-          true
+          attach_and_define_method method, go, build_class
         end
 
         private
@@ -76,11 +58,7 @@ module GirFFI
         end
 
         def layout_specification
-          fields = if info.info_type == :interface
-                     []
-                   else
-                     info.fields
-                   end
+          fields = info.fields
 
           if fields.empty?
             if parent

data/lib/gir_ffi/class_base.rb

@@ -20,13 +20,16 @@ module GirFFI
     end
 
     def setup_and_call method, *arguments, &block
-      result = gir_ffi_builder.setup_instance_method method.to_s
-      return super unless result
+      unless gir_ffi_builder.setup_instance_method method.to_s
+        raise RuntimeError, "Unable to set up instance method #{method} in #{self}"
+      end
       self.send method, *arguments, &block
     end
 
     def self.setup_and_call method, *arguments, &block
-      gir_ffi_builder.setup_method method.to_s
+      unless gir_ffi_builder.setup_method method.to_s
+        raise RuntimeError, "Unable to set up method #{method} in #{self}"
+      end
       self.send method, *arguments, &block
     end
 

data/test/dynamic_type_builder_test.rb

@@ -0,0 +1,40 @@
+require File.expand_path('test_helper.rb', File.dirname(__FILE__))
+
+require 'gir_ffi/builder/dynamic_type'
+
+describe "GirFFI::Builder::DynamicType" do
+  describe "building the GLocalFile type" do
+    before do
+      # Ensure existence of GLocalFile type
+      GirFFI.setup :Gio
+      unless Gio::Lib.respond_to? :g_file_new_for_path
+        Gio.gir_ffi_builder.setup_function "file_new_for_path"
+      end
+      ptr = GirFFI::ArgHelper.utf8_to_inptr '/'
+      Gio::Lib.g_file_new_for_path(ptr)
+
+      @gtype = GObject.type_from_name 'GLocalFile'
+      bldr = GirFFI::Builder::DynamicType.new(@gtype)
+      @klass = bldr.build_class
+    end
+
+    it "builds a class" do
+      assert_instance_of Class, @klass
+    end
+
+    it "builds a class derived from GObject::Object" do
+      assert_includes @klass.ancestors, GObject::Object
+    end
+
+    it "builds a class derived from Gio::File" do
+      assert_includes @klass.ancestors, Gio::File
+    end
+
+    it "returns the same class when built again" do
+      other_bldr = GirFFI::Builder::DynamicType.new(@gtype)
+      other_klass = other_bldr.build_class
+
+      assert_equal @klass, other_klass
+    end
+  end
+end

data/test/generated_gio_test.rb

@@ -7,10 +7,18 @@ class GeneratedGioTest < MiniTest::Spec
       GirFFI.setup :Gio
     end
 
-    should "create a GFile with #file_new_from_path" do
-      assert_nothing_raised {
-	Gio.file_new_for_path('/')
-      }
+    describe "#file_new_from_path, a method returning an interface," do
+      it "does not throw an error when generated" do
+        assert_nothing_raised {
+          Gio.file_new_for_path('/')
+        }
+      end
+
+      it "returns an object of a more specific class" do
+        file = Gio.file_new_for_path('/')
+        refute_instance_of Gio::File, file
+        assert_includes file.class.ancestors, Gio::File
+      end
     end
 
     context "the FileInfo class" do
@@ -21,9 +29,8 @@ class GeneratedGioTest < MiniTest::Spec
 	end
 
 	should "hava a working #get_attribute_type method" do
-	  assert_nothing_raised {
-	    @fileinfo.get_attribute_type "standard::displayname"
-	  }
+	  type = @fileinfo.get_attribute_type "standard::display-name"
+          assert_equal :string, type
 	end
       end
     end

data/test/generated_gobject_test.rb

@@ -0,0 +1,15 @@
+require File.expand_path('test_helper.rb', File.dirname(__FILE__))
+
+describe "The generated GObject module" do
+  before do
+    GirFFI.setup :GObject
+  end
+
+  describe "#type_interfaces" do
+    it "works, showing that returning an array of GType works" do
+      tp = GObject.type_from_name 'GTypeModule'
+      ifcs = GObject.type_interfaces tp
+      assert_equal 1, ifcs.size
+    end
+  end
+end

data/test/generated_gtk_test.rb

@@ -45,7 +45,7 @@ class GeneratedGtkTest < MiniTest::Spec
 	  assert_equal "clicked", sn
 	  assert_equal "on_button_clicked", hn
 	  assert_equal nil, co
-	  assert_equal :after, f
+	  assert_equal 0, f
 	  assert_equal nil, ud
 	end
       end

data/test/interface_type_builder_test.rb

@@ -0,0 +1,17 @@
+require File.expand_path('test_helper.rb', File.dirname(__FILE__))
+
+describe GirFFI::Builder::Type::Interface do
+  before do
+    info = get_function_introspection_data 'GObject', 'TypePlugin'
+    @bldr = GirFFI::Builder::Type::Interface.new info
+    @iface = @bldr.build_class
+  end
+
+  it "builds an interface as a module" do
+    assert_instance_of Module, @iface
+  end
+
+  it "creates methods on the interface" do
+    assert_includes @iface.instance_methods.map(&:to_s), 'complete_interface_info'
+  end
+end

data/test/object_type_builder_test.rb

@@ -0,0 +1,34 @@
+require File.expand_path('test_helper.rb', File.dirname(__FILE__))
+
+describe GirFFI::Builder::Type::Object do
+  describe "building GObject::TypeModule, which implements an interface" do
+    before do
+      info = get_function_introspection_data 'GObject', 'TypeModule'
+      @bldr = GirFFI::Builder::Type::Object.new info
+    end
+
+    it "mixes the interface into the generated class" do
+      klass = @bldr.build_class
+      assert_includes klass.ancestors, GObject::TypePlugin
+    end
+  end
+
+  describe "building the CharsetConverter class" do
+    before do
+      GirFFI.setup :Gio
+    end
+
+    it "includes two interfaces" do
+      klass = Gio::CharsetConverter
+      assert_includes klass.ancestors, Gio::Converter
+      assert_includes klass.ancestors, Gio::Initable
+    end
+
+    it "allows an instance to find the #reset method" do
+      cnv = Gio::CharsetConverter.new "utf8", "utf8"
+      cnv.reset
+      pass
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -1,3 +1,9 @@
+if RUBY_PLATFORM == 'java'
+  require 'java'
+  JRuby.objectspace = true
+  require 'rubygems'
+end
+
 require 'minitest/spec'
 require 'minitest/autorun'
 require 'rr'
@@ -9,11 +15,6 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'gir_ffi'
 
-if RUBY_PLATFORM == 'java'
-  require 'java'
-  JRuby.objectspace = true
-end
-
 # Since the tests will call Gtk+ functions, Gtk+ must be initialized.
 GirFFI.setup :Gtk, '2.0'
 Gtk.init
@@ -47,6 +48,7 @@ class MiniTest::Unit::TestCase
     code.gsub(/(^\s*|\s*$)/, "")
   end
 
+  # FIXME: Rename. It can also get object, interface, etc., data.
   def get_function_introspection_data namespace, function
     gir = GirFFI::IRepository.default
     gir.require namespace, nil

data/test/type_builder_test.rb

@@ -62,8 +62,8 @@ class TypeBuilderTest < MiniTest::Spec
 	@cbuilder = GirFFI::Builder::Type::Union.new get_function_introspection_data('GObject', 'TypeCValue')
       end
 
-      should "not raise an error looking for a method that doesn't exist" do
-	assert_nothing_raised { @cbuilder.setup_instance_method 'blub' }
+      should "returns false looking for a method that doesn't exist" do
+	assert_equal false, @cbuilder.setup_instance_method('blub')
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gir_ffi
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: 
   segments: 
   - 0
   - 0
-  - 9
-  version: 0.0.9
+  - 10
+  version: 0.0.10
 platform: ruby
 authors: 
 - Matijs van Zuijlen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-02 00:00:00 Z
+date: 2011-05-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ffi
@@ -25,12 +25,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 7
         segments: 
         - 1
         - 0
-        - 4
-        version: 1.0.4
+        - 8
+        version: 1.0.8
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -86,6 +86,7 @@ files:
 - lib/gir_ffi/g_error.rb
 - lib/gir_ffi/i_object_info.rb
 - lib/gir_ffi/builder.rb
+- lib/gir_ffi/builder/dynamic_type.rb
 - lib/gir_ffi/builder/module.rb
 - lib/gir_ffi/builder/function.rb
 - lib/gir_ffi/builder/type/base.rb
@@ -137,9 +138,11 @@ files:
 - test/lib/autogen.sh
 - test/lib/configure.ac
 - test/lib/m4/jhflags.m4
+- test/dynamic_type_builder_test.rb
 - test/class_base_test.rb
 - test/test_helper.rb
 - test/girffi_test.rb
+- test/interface_type_builder_test.rb
 - test/module_builder_test.rb
 - test/i_object_info_test.rb
 - test/g_object_overrides_test.rb
@@ -148,6 +151,8 @@ files:
 - test/builder_test.rb
 - test/glib_overrides_test.rb
 - test/gtk_overrides_test.rb
+- test/object_type_builder_test.rb
+- test/generated_gobject_test.rb
 - test/generated_gio_test.rb
 - test/generated_gimarshallingtests_test.rb
 - tasks/test.rake
@@ -204,11 +209,13 @@ test_files:
 - test/arg_helper_test.rb
 - test/builder_test.rb
 - test/class_base_test.rb
+- test/dynamic_type_builder_test.rb
 - test/function_definition_builder_test.rb
 - test/g_object_overrides_test.rb
 - test/g_object_test.rb
 - test/generated_gimarshallingtests_test.rb
 - test/generated_gio_test.rb
+- test/generated_gobject_test.rb
 - test/generated_gtk_test.rb
 - test/generated_regress_test.rb
 - test/girffi_test.rb
@@ -216,10 +223,12 @@ test_files:
 - test/gtk_overrides_test.rb
 - test/i_object_info_test.rb
 - test/i_repository_test.rb
+- test/interface_type_builder_test.rb
 - test/lib/Makefile.am
 - test/lib/autogen.sh
 - test/lib/configure.ac
 - test/lib/m4/jhflags.m4
 - test/module_builder_test.rb
+- test/object_type_builder_test.rb
 - test/test_helper.rb
 - test/type_builder_test.rb