gir_ffi 0.4.1 → 0.4.2

data/History.txt

@@ -1,3 +1,8 @@
+== 0.4.2 / 2012-09-22
+
+* Make objects and interfaces wrap poiners in the class that matches
+  their GType.
+
 == 0.4.1 / 2012-09-18
 
 * Remove workarounds for older versions of gobject-introspection

data/lib/gir_ffi/arg_helper.rb

@@ -117,7 +117,7 @@ module GirFFI
     def self.wrap_object_pointer_by_gtype optr, gtype
       return nil if optr.null?
       klass = Builder.build_by_gtype gtype
-      klass.wrap optr
+      klass.direct_wrap optr
     end
 
     def self.cast_from_pointer type, it

data/lib/gir_ffi/builder/argument.rb

@@ -456,7 +456,7 @@ module GirFFI::Builder
   # Implements argument processing for object return values.
   class ObjectReturnValue < ReturnValue
     def post
-      [ "#{retname} = GirFFI::ArgHelper.object_pointer_to_object(#{cvar})" ]
+      [ "#{retname} = #{argument_class_name}.wrap(#{cvar})" ]
     end
   end
 

data/lib/gir_ffi/builder/type.rb

@@ -13,6 +13,8 @@ module GirFFI
   # repository.
   module Builder
     module Type
+      CACHE = {}
+
       TYPE_MAP = {
         :callback => Callback,
         :constant => Constant,

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

@@ -7,8 +7,6 @@ module GirFFI
       # which no data is found in the GIR. Typically, these are created to
       # cast objects returned by a function that returns an interface.
       class Unintrospectable < Object
-        CACHE = {}
-
         # FIXME: Breaks parent interface.
         def initialize gtype
           @gtype = gtype

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

@@ -36,6 +36,7 @@ module GirFFI
           @gtype = new_type
           @structklass = get_or_define_class @klass, :Struct, layout_superclass
           setup_class unless already_set_up
+          CACHE[@gtype] = @klass
         end
 
         def setup_class
@@ -61,7 +62,7 @@ module GirFFI
 
         def install_property pspec
           pinfo = GirFFI::UserDefined::IPropertyInfo.new
-          pinfo.name = pspec.parent_instance.get_name
+          pinfo.name = pspec.get_name
           properties << pinfo
         end
 

data/lib/gir_ffi/class_base.rb

@@ -75,7 +75,15 @@ module GirFFI
       alias_method :_real_new, :new
       undef new
 
+      # Wrap the passed pointer in an instance of the current class, or a
+      # descendant type if applicable.
       def wrap ptr
+        direct_wrap ptr
+      end
+
+      # Wrap the passed pointer in an instance of the current class. Will not
+      # do any casting to subtypes.
+      def direct_wrap ptr
         return nil if ptr.nil? or ptr.null?
         obj = _real_new
         obj.instance_variable_set :@struct, self::Struct.new(ptr.to_ptr)

data/lib/gir_ffi/interface_base.rb

@@ -17,6 +17,10 @@ module GirFFI
     def setup_instance_method name
       _builder.setup_instance_method name
     end
+
+    def wrap ptr
+      GirFFI::ArgHelper.object_pointer_to_object ptr
+    end
   end
 end
 

data/lib/gir_ffi/object_base.rb

@@ -2,16 +2,25 @@ 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 wrap, but, e.g., InitiallyUnowned
+    # 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
-      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
+      GirFFI::ArgHelper.object_pointer_to_object ptr
     end
 
     #

data/lib/gir_ffi/version.rb

@@ -1,4 +1,4 @@
 module GirFFI
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end
 

data/test/gir_ffi/arg_helper_test.rb

@@ -96,7 +96,7 @@ describe GirFFI::ArgHelper do
 
       object_class = Class.new
       mock(GirFFI::Builder).build_by_gtype(0xdeadbeef) { object_class }
-      mock(object_class).wrap(objptr) { "good-result" }
+      mock(object_class).direct_wrap(objptr) { "good-result" }
 
       r = GirFFI::ArgHelper.object_pointer_to_object objptr
       assert_equal "good-result", r

data/test/gir_ffi/interface_base_test.rb

@@ -0,0 +1,14 @@
+require 'gir_ffi_test_helper'
+
+describe GirFFI::InterfaceBase do
+  describe "#wrap" do
+    it "dynamically looks op the wrapped object's class" do
+      mod = Module.new { extend GirFFI::InterfaceBase }
+
+      mock(GirFFI::ArgHelper).object_pointer_to_object("some-pointer") { "good-result" }
+
+      mod.wrap("some-pointer").must_equal "good-result"
+    end
+  end
+end
+

data/test/gir_ffi/object_base_test.rb

@@ -0,0 +1,15 @@
+require 'gir_ffi_test_helper'
+
+describe GirFFI::ObjectBase do
+  describe "#wrap" do
+    it "dynamically looks op the wrapped object's class" do
+      mod = Class.new GirFFI::ObjectBase
+
+      mock(GirFFI::ArgHelper).object_pointer_to_object("some-pointer") { "good-result" }
+
+      mod.wrap("some-pointer").must_equal "good-result"
+    end
+  end
+end
+
+

data/test/gir_ffi_test.rb

@@ -56,6 +56,11 @@ describe GirFFI do
         type = GObject.type_from_instance obj
         type.must_equal @gtype
       end
+
+      it "makes GirFFI find the new class by GType" do
+        klass = GirFFI::Builder.build_by_gtype @gtype
+        klass.must_equal @klass
+      end
     end
 
     describe "with a block with a call to #install_property" do

data/test/integration/generated_regress_test.rb

@@ -149,8 +149,7 @@ describe Regress, "The generated Regress module" do
     end
 
     it "has a refcount of 1" do
-      # FIXME: Should be able to do @so.refcount
-      assert_equal 1, @so.fundamental_object.refcount
+      assert_equal 1, @so.refcount
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gir_ffi
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-18 00:00:00.000000000 Z
+date: 2012-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -220,6 +220,7 @@ files:
 - test/gir_ffi/builder/module_test.rb
 - test/gir_ffi/builder/function_test.rb
 - test/gir_ffi/builder/argument/base_test.rb
+- test/gir_ffi/object_base_test.rb
 - test/gir_ffi/user_defined/i_registered_type_info_test.rb
 - test/gir_ffi/user_defined/i_object_info_test.rb
 - test/gir_ffi/user_defined/i_property_info_test.rb
@@ -232,6 +233,7 @@ files:
 - test/gir_ffi/class_base_test.rb
 - test/gir_ffi/info_ext/i_type_info_test.rb
 - test/gir_ffi/info_ext/i_field_info_test.rb
+- test/gir_ffi/interface_base_test.rb
 - test/gir_ffi-base/glib/strv_test.rb
 - test/ffi-gobject/object_class_test.rb
 - test/ffi-gobject/object_test.rb
@@ -339,6 +341,8 @@ test_files:
 - test/gir_ffi/in_pointer_test.rb
 - test/gir_ffi/info_ext/i_field_info_test.rb
 - test/gir_ffi/info_ext/i_type_info_test.rb
+- test/gir_ffi/interface_base_test.rb
+- test/gir_ffi/object_base_test.rb
 - test/gir_ffi/user_defined/i_object_info_test.rb
 - test/gir_ffi/user_defined/i_property_info_test.rb
 - test/gir_ffi/user_defined/i_registered_type_info_test.rb