gir_ffi 0.8.6 → 0.9.0

data/lib/gir_ffi/builders/type_builder.rb

@@ -1,10 +1,12 @@
 require 'gir_ffi/builders/callback_builder'
 require 'gir_ffi/builders/constant_builder'
 require 'gir_ffi/builders/enum_builder'
+require 'gir_ffi/builders/flags_builder'
 require 'gir_ffi/builders/interface_builder'
 require 'gir_ffi/builders/object_builder'
 require 'gir_ffi/builders/struct_builder'
 require 'gir_ffi/builders/signal_closure_builder'
+require 'gir_ffi/builders/unintrospectable_boxed_builder'
 require 'gir_ffi/builders/unintrospectable_builder'
 require 'gir_ffi/builders/union_builder'
 require 'gir_ffi/builders/vfunc_builder'
@@ -17,15 +19,16 @@ module GirFFI
       CACHE = {}
 
       TYPE_MAP = {
-        callback:         CallbackBuilder,
-        constant:         ConstantBuilder,
-        enum:             EnumBuilder,
-        flags:            EnumBuilder,
-        interface:        InterfaceBuilder,
-        object:           ObjectBuilder,
-        struct:           StructBuilder,
-        union:            UnionBuilder,
-        unintrospectable: UnintrospectableBuilder
+        callback:               CallbackBuilder,
+        constant:               ConstantBuilder,
+        enum:                   EnumBuilder,
+        flags:                  FlagsBuilder,
+        interface:              InterfaceBuilder,
+        object:                 ObjectBuilder,
+        struct:                 StructBuilder,
+        union:                  UnionBuilder,
+        unintrospectable_boxed: UnintrospectableBoxedBuilder,
+        unintrospectable:       UnintrospectableBuilder
       }
 
       def self.build(info)

data/lib/gir_ffi/builders/unintrospectable_boxed_builder.rb

@@ -0,0 +1,26 @@
+require 'gir_ffi/builders/boxed_builder'
+
+module GirFFI
+  module Builders
+    # Implements the creation of a class representing a boxed type for
+    # which no data is found in the GIR.
+    class UnintrospectableBoxedBuilder < BoxedBuilder
+      def klass
+        @klass ||= TypeBuilder::CACHE[target_gtype] ||= Class.new(superclass)
+      end
+
+      def setup_class
+        setup_layout
+        setup_constants
+      end
+
+      def superclass
+        BoxedBase
+      end
+
+      def layout_superclass
+        FFI::Struct
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/user_defined_builder.rb

@@ -35,11 +35,11 @@ module GirFFI
       end
 
       def parent_info
-        @parent_info ||= gir.find_by_gtype(parent_gtype.to_i)
+        @info.parent
       end
 
       def parent_gtype
-        @parent_gtype ||= GType.new(klass.superclass.gtype)
+        @info.parent_gtype
       end
 
       def interface_gtypes

data/lib/gir_ffi/builders/with_layout.rb

@@ -4,7 +4,7 @@ module GirFFI
   module Builders
     # Implements the creation of classes representing types with layout,
     # i.e., :union, :struct, :object.
-    # Note: This module depends on methods in RegisteredTypeBuilder.
+    # NOTE: This module depends on methods in RegisteredTypeBuilder.
     module WithLayout
       def layout_specification
         spec = base_layout_specification

data/lib/gir_ffi/callback_base.rb

@@ -31,25 +31,33 @@ module GirFFI
       from_native ptr, nil
     end
 
-    CALLBACKS = []
+    CALLBACKS = {}
 
     def self.store_callback(prc)
-      CALLBACKS << prc
+      CALLBACKS[prc.object_id] = prc
+    end
+
+    def self.drop_callback(key)
+      CALLBACKS.delete key
     end
 
     # Create Callback from a Proc. Makes sure arguments are properly wrapped,
     # and the callback is stored to prevent garbage collection.
     def self.from(prc)
-      wrap_in_callback_args_mapper(prc).tap do |cb|
+      wrap_proc(prc).tap do |cb|
         store_callback cb
       end
     end
 
-    def self.wrap_in_callback_args_mapper(prc)
+    def self.wrap_proc(prc)
       return unless prc
 
       new do |*args|
-        call_with_argument_mapping(prc, *args)
+        begin
+          call_with_argument_mapping(prc, *args)
+        rescue => e
+          GLib::MainLoop.handle_exception e
+        end
       end
     end
 

data/lib/gir_ffi/core.rb

@@ -1,4 +1,5 @@
 require 'ffi'
+require 'ffi/bit_masks'
 
 require 'gir_ffi-base'
 

data/lib/gir_ffi/error_argument_info.rb

@@ -23,6 +23,10 @@ module GirFFI
       -1
     end
 
+    def destroy
+      -1
+    end
+
     def caller_allocates?
       true
     end

data/lib/gir_ffi/flags_base.rb

@@ -0,0 +1,63 @@
+require 'gir_ffi/registered_type_base'
+
+module GirFFI
+  # Base module for flags.
+  module FlagsBase
+    include FFI::DataConverter
+    include RegisteredTypeBase
+
+    def native_type
+      self::BitMask.native_type
+    end
+
+    def to_native(value, context)
+      case value
+      when Symbol
+        value = { value => true }
+      end
+      self::BitMask.to_native(value, context)
+    end
+
+    def from_native(*args)
+      self::BitMask.from_native(*args).select { |_k, v| v }
+    end
+
+    def [](arg)
+      self::BitMask[arg]
+    end
+
+    def wrap(arg)
+      self[arg]
+    end
+
+    def from(arg)
+      self[arg]
+    end
+
+    def copy_value_to_pointer(value, pointer)
+      pointer.put_int32 0, to_native(value, nil)
+    end
+
+    def get_value_from_pointer(pointer, offset)
+      from_native pointer.get_int32(offset), nil
+    end
+
+    def setup_and_call(method, arguments, &block)
+      result = setup_method method.to_s
+
+      unless result
+        raise "Unable to set up method #{method} in #{self}"
+      end
+
+      send method, *arguments, &block
+    end
+
+    def to_ffi_type
+      self
+    end
+
+    def setup_method(name)
+      gir_ffi_builder.setup_method name
+    end
+  end
+end

data/lib/gir_ffi/in_pointer.rb

@@ -47,9 +47,7 @@ module GirFFI
 
     class << self
       def from_closure_data(obj)
-        FFI::Pointer.new(obj.object_id).tap do |ptr|
-          ArgHelper::OBJECT_STORE.store(ptr, obj)
-        end
+        ArgHelper::OBJECT_STORE.store(obj)
       end
 
       private

data/lib/gir_ffi/info_ext/i_type_info.rb

@@ -180,6 +180,12 @@ module GirFFI
         end
       end
 
+      GOBJECT_VALUE_NAME = 'GObject::Value'
+
+      def gvalue?
+        argument_class_name == GOBJECT_VALUE_NAME
+      end
+
       private
 
       def subtype_tag_or_class(index)

data/lib/gir_ffi/object_base.rb

@@ -5,6 +5,10 @@ module GirFFI
   class ObjectBase < ClassBase
     extend FFI::DataConverter
 
+    def object_class
+      self.class.object_class
+    end
+
     def self.native_type
       FFI::Type::POINTER
     end
@@ -54,7 +58,11 @@ module GirFFI
     end
 
     def self.object_class
-      gir_ffi_builder.object_class
+      @object_class ||=
+        begin
+          ptr = GObject.type_class_ref(gtype).to_ptr
+          gir_ffi_builder.object_class_struct.wrap ptr
+        end
     end
   end
 end

data/lib/gir_ffi/object_store.rb

@@ -0,0 +1,26 @@
+module GirFFI
+  # Helper class for storing objects for later retrieval. Used to store user
+  # data arguments.
+  class ObjectStore
+    def initialize
+      @store = {}
+    end
+
+    def store(obj)
+      # FIXME: Don't use object_id!
+      key = obj.object_id
+      @store[key] = obj
+      FFI::Pointer.new(key)
+    end
+
+    def fetch(ptr)
+      return if ptr.null?
+      key = ptr.address
+      if @store.key? key
+        @store[key]
+      else
+        ptr
+      end
+    end
+  end
+end

data/lib/gir_ffi/unintrospectable_boxed_info.rb

@@ -0,0 +1,31 @@
+require 'gir_ffi/info_ext/full_type_name'
+
+module GirFFI
+  # Represents a boxed type not found in the GIR, conforming, as needed, to the
+  # interface of GObjectIntrospection::IUnionInfo and GObjectIntrospection::IStructInfo.
+  class UnintrospectableBoxedInfo
+    attr_reader :g_type
+
+    def initialize(gtype)
+      @g_type = gtype
+    end
+
+    def info_type
+      :unintrospectable_boxed
+    end
+
+    def safe_name
+      GObject.type_name g_type
+    end
+
+    DEFAULT_BOXED_NAMESPACE = 'GLib'
+
+    def namespace
+      DEFAULT_BOXED_NAMESPACE
+    end
+
+    def fields
+      []
+    end
+  end
+end

data/lib/gir_ffi/unintrospectable_type_info.rb

@@ -47,5 +47,10 @@ module GirFFI
     def find_signal(_any)
       nil
     end
+
+    # TODO: Create custom class that includes the interfaces instead
+    def class_struct
+      parent.class_struct
+    end
   end
 end

data/lib/gir_ffi/user_defined_type_info.rb

@@ -35,10 +35,29 @@ module GirFFI
       nil
     end
 
+    def parent_gtype
+      @parent_gtype ||= GType.new(@klass.superclass.gtype)
+    end
+
+    def parent
+      @parent ||= gir.find_by_gtype(parent_gtype.to_i)
+    end
+
+    # TODO: Create custom class that includes the interfaces instead
+    def class_struct
+      parent.class_struct
+    end
+
     attr_writer :g_name
 
     def g_name
       @g_name ||= @klass.name
     end
+
+    private
+
+    def gir
+      @gir ||= GObjectIntrospection::IRepository.default
+    end
   end
 end

data/lib/gir_ffi/version.rb

@@ -1,4 +1,4 @@
 # Current GirFFI version
 module GirFFI
-  VERSION = '0.8.6'
+  VERSION = '0.9.0'
 end

data/test/ffi-glib/destroy_notify_test.rb

@@ -0,0 +1,13 @@
+require 'gir_ffi_test_helper'
+
+describe GLib::DestroyNotify do
+  describe '.default' do
+    it 'removes the passed-in key from the callback store' do
+      dummy_proc = 'some-callback'
+      GirFFI::CallbackBase.store_callback dummy_proc
+      user_data = GirFFI::InPointer.from_closure_data dummy_proc.object_id
+      GLib::DestroyNotify.default.call user_data
+      GirFFI::CallbackBase::CALLBACKS[dummy_proc.object_id].must_be_nil
+    end
+  end
+end

data/test/ffi-glib/main_loop_test.rb

@@ -6,9 +6,9 @@ describe GLib::MainLoop do
       main_loop = GLib::MainLoop.new nil, false
 
       a = []
-      GLib.timeout_add(GLib::PRIORITY_DEFAULT, 150,
-                       proc { main_loop.quit },
-                       nil, nil)
+      GLib.timeout_add GLib::PRIORITY_DEFAULT, 150 do
+        main_loop.quit
+      end
 
       slow_thread = Thread.new do
         sleep 0.001

data/test/ffi-gobject/object_class_test.rb

@@ -18,4 +18,12 @@ describe GObject::ObjectClass do
       prop_names.sort.must_equal expected_props.sort
     end
   end
+
+  describe '#gtype' do
+    it 'returns the correct GType' do
+      obj = GIMarshallingTests::OverridesObject.new
+      object_class = GObject.object_class_from_instance obj
+      object_class.gtype.must_equal GIMarshallingTests::OverridesObject.gtype
+    end
+  end
 end

data/test/ffi-gobject/object_test.rb

@@ -1,11 +1,25 @@
 require 'gir_ffi_test_helper'
 
 require 'ffi-gobject'
+GirFFI.setup :GIMarshallingTests
 
 describe GObject::Object do
   describe '.new' do
     it 'is overridden to take only one argument' do
-      GObject::Object.new(nil).must_be_instance_of GObject::Object
+      GObject::Object.new({}).must_be_instance_of GObject::Object
+    end
+
+    it 'can be used to create objects with properties' do
+      obj = GIMarshallingTests::SubObject.new(int: 13)
+      obj.int.must_equal 13
+    end
+
+    it 'allows omission of the first argument' do
+      GObject::Object.new.must_be_instance_of GObject::Object
+    end
+
+    it 'raises an error for properties that do not exist' do
+      proc { GObject::Object.new(dog: 'bark') }.must_raise ArgumentError
     end
   end
 
@@ -26,7 +40,7 @@ describe GObject::Object do
       end
     end
 
-    subject { AccessorTest.new nil }
+    subject { AccessorTest.new }
 
     it 'reads x by calling get_x' do
       subject.set_x(1)
@@ -40,7 +54,7 @@ describe GObject::Object do
   end
 
   describe '#signal_connect' do
-    subject { GObject::Object.new nil }
+    subject { GObject::Object.new }
 
     it 'delegates to GObject' do
       expect(GObject).to receive(:signal_connect).with(subject, 'some-event', nil)
@@ -58,7 +72,7 @@ describe GObject::Object do
   end
 
   describe '#signal_connect_after' do
-    subject { GObject::Object.new nil }
+    subject { GObject::Object.new }
 
     it 'delegates to GObject' do
       expect(GObject).to receive(:signal_connect_after).with(subject, 'some-event', nil)
@@ -76,12 +90,16 @@ describe GObject::Object do
   end
 
   describe 'upon garbage collection' do
+    # FIXME: Test this some other way
     it 'lowers the reference count' do
       if defined?(RUBY_ENGINE) && %w(jruby rbx).include?(RUBY_ENGINE)
         skip 'cannot be reliably tested on JRuby and Rubinius'
       end
+      if RUBY_VERSION >= '2.3.0'
+        skip 'cannot be reliably tested on CRuby >= 2.3'
+      end
 
-      object = GObject::Object.new nil
+      object = GObject::Object.new
       ptr = object.to_ptr
       ref_count(ptr).must_equal 1