gir_ffi 0.9.5 → 0.10.0.pre1

data/lib/gir_ffi/builders/{boxed_builder.rb → struct_like.rb}

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
-require 'gir_ffi/builders/registered_type_builder'
 require 'gir_ffi/builders/with_layout'
 
 module GirFFI
   module Builders
-    # Implements the creation of a class representing boxed types.
-    class BoxedBuilder < RegisteredTypeBuilder
+    # Implements base methods used by struct and union builders
+    module StructLike
       include WithLayout
 
-      private
-
       def setup_class
         setup_layout
         setup_constants

data/lib/gir_ffi/builders/unintrospectable_boxed_builder.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
-require 'gir_ffi/builders/boxed_builder'
+require 'gir_ffi/builders/registered_type_builder'
+require 'gir_ffi/builders/struct_like'
 
 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
+    class UnintrospectableBoxedBuilder < RegisteredTypeBuilder
+      include StructLike
+
       def klass
         @klass ||= TypeBuilder::CACHE[target_gtype] ||= Class.new(superclass)
       end

data/lib/gir_ffi/builders/union_builder.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
-require 'gir_ffi/builders/boxed_builder'
+require 'gir_ffi/builders/registered_type_builder'
+require 'gir_ffi/builders/struct_like'
 require 'gir_ffi/union_base'
 
 module GirFFI
   module Builders
     # Implements the creation of a class representing union type. The
     # class will have a nested FFI::Union class to represent its C union.
-    class UnionBuilder < BoxedBuilder
+    class UnionBuilder < RegisteredTypeBuilder
+      include StructLike
+
       def layout_superclass
         FFI::Union
       end

data/lib/gir_ffi/enum_base.rb

@@ -31,6 +31,10 @@ module GirFFI
       self[arg]
     end
 
+    def size
+      native_type.size
+    end
+
     def copy_value_to_pointer(value, pointer)
       pointer.put_int32 0, to_native(value, nil)
     end

data/lib/gir_ffi/error_argument_info.rb

@@ -4,10 +4,6 @@ require 'gir_ffi/error_type_info'
 module GirFFI
   # Represents an error argument with the same interface as IArgumentInfo
   class ErrorArgumentInfo
-    def skip?
-      false
-    end
-
     def direction
       :error
     end
@@ -19,17 +15,5 @@ module GirFFI
     def name
       '_error'
     end
-
-    def closure
-      -1
-    end
-
-    def destroy
-      -1
-    end
-
-    def caller_allocates?
-      true
-    end
   end
 end

data/lib/gir_ffi/ffi_ext/pointer.rb

@@ -7,10 +7,6 @@ module GirFFI
         self
       end
 
-      def to_value
-        self
-      end
-
       def zero?
         null?
       end
@@ -29,5 +25,15 @@ module GirFFI
   end
 end
 
-# TODO: Move use to InPointer and InOutPointer?
 FFI::Pointer.send :include, GirFFI::FFIExt::Pointer
+
+FFI::Pointer.class_eval do
+  case FFI.type_size(:size_t)
+  when 4
+    alias_method :get_size_t, :get_uint32
+  when 8
+    alias_method :get_size_t, :get_uint64
+  end
+
+  alias_method :get_gtype, :get_size_t
+end

data/lib/gir_ffi/flags_base.rb

@@ -35,6 +35,10 @@ module GirFFI
       self[arg]
     end
 
+    def size
+      native_type.size
+    end
+
     def copy_value_to_pointer(value, pointer)
       pointer.put_int32 0, to_native(value, nil)
     end

data/lib/gir_ffi/in_out_pointer.rb

@@ -3,18 +3,14 @@ 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 extended pointer class and should be renamed.
   class InOutPointer < FFI::Pointer
     attr_reader :value_type
 
-    def initialize(type, ptr = nil)
+    def initialize(type, ptr)
       @value_type = type
-
-      ptr ||= AllocationHelper.safe_malloc(value_type_size)
       super ptr
     end
 
-    # TODO: Create type classes that extract values from pointers.
     def to_value
       case value_ffi_type
       when Module
@@ -41,27 +37,10 @@ module GirFFI
       end
     end
 
-    def set_value(value)
-      case value_ffi_type
-      when Module
-        value_ffi_type.copy_value_to_pointer(value, self)
-      when Symbol
-        send "put_#{value_ffi_type}", 0, value
-      else
-        raise NotImplementedError, value_ffi_type
-      end
-    end
-
-    def clear
-      put_bytes 0, "\x00" * value_type_size, 0, value_type_size
-    end
-
-    def self.for(type)
-      new(type).tap(&:clear)
-    end
-
-    def self.from(type, value)
-      new(type).tap { |ptr| ptr.set_value value }
+    def self.allocate_new(type)
+      ffi_type = TypeMap.type_specification_to_ffi_type type
+      ptr = AllocationHelper.allocate(ffi_type)
+      new type, ptr
     end
 
     private
@@ -69,9 +48,5 @@ module GirFFI
     def value_ffi_type
       @value_ffi_type ||= TypeMap.type_specification_to_ffi_type value_type
     end
-
-    def value_type_size
-      @value_type_size ||= FFI.type_size value_ffi_type
-    end
   end
 end

data/lib/gir_ffi/in_pointer.rb

@@ -47,10 +47,6 @@ module GirFFI
     end
 
     class << self
-      def from_closure_data(obj)
-        ArgHelper::OBJECT_STORE.store(obj)
-      end
-
       private
 
       def from_utf8_array(ary)
@@ -93,12 +89,17 @@ module GirFFI
         from_basic_type_array :int32, ary.map { |sym| type.to_native sym, nil }
       end
 
+      public
+
       def from_utf8(str)
+        return unless str
         len = str.bytesize
         ptr = AllocationHelper.safe_malloc(len + 1).write_string(str).put_char(len, 0)
         new ptr
       end
 
+      private
+
       def from_basic_type_array(type, ary)
         ffi_type = TypeMap.type_specification_to_ffi_type type
         ary = ary.dup << null_value(ffi_type)

data/lib/gir_ffi/info_ext/i_type_info.rb

@@ -81,8 +81,8 @@ module GirFFI
         gslist:          'GLib::SList',
         ptr_array:       'GLib::PtrArray',
         strv:            'GLib::Strv',
-        utf8:            'GirFFI::InPointer',
-        void:            'GirFFI::InPointer',
+        utf8:            'GirFFI::InPointer', # TODO: Create a string-like class
+        void:            'GirFFI::InPointer', # TODO: Create a void-pointer class
         zero_terminated: 'GirFFI::ZeroTerminated'
       }.freeze
 
@@ -130,7 +130,7 @@ module GirFFI
 
       TAGS_NEEDING_RUBY_TO_C_CONVERSION = [
         :array, :c, :callback, :error, :ghash, :glist, :gslist, :object,
-        :ptr_array, :struct, :strv, :utf8, :void, :zero_terminated
+        :ptr_array, :struct, :strv, :utf8, :zero_terminated
       ].freeze
 
       TAGS_NEEDING_C_TO_RUBY_CONVERSION = [
@@ -175,8 +175,6 @@ module GirFFI
 
       def extra_conversion_arguments
         case flattened_tag
-        when :utf8, :void
-          [flattened_tag]
         when :c
           [element_type, array_fixed_size]
         when :array, :ghash, :glist, :gslist, :ptr_array, :zero_terminated

data/lib/gir_ffi/object_base.rb

@@ -36,6 +36,10 @@ module GirFFI
       ptr.to_object
     end
 
+    def self.copy_from(val)
+      val.ref if val
+    end
+
     #
     # Find property info for the named property.
     #

data/lib/gir_ffi/sized_array.rb

@@ -71,6 +71,26 @@ module GirFFI
         end
       end
 
+      def copy_from(element_type, size, item)
+        return unless item
+
+        enumerable = case item
+                     when FFI::Pointer
+                       wrap(element_type, size, item).to_a
+                     when self
+                       item.to_a
+                     else
+                       item
+                     end
+        case element_type
+        when Array
+          _main_type, sub_type = *element_type
+          enumerable = enumerable.map { |it| sub_type.copy_from it }
+        end
+
+        from_enumerable element_type, size, enumerable
+      end
+
       private
 
       def from_sized_array(size, sized_array)

data/lib/gir_ffi/struct_base.rb

@@ -1,8 +1,19 @@
 # frozen_string_literal: true
-require 'gir_ffi/boxed_base'
+require 'gir_ffi/struct_like_base'
 
 module GirFFI
   # Base class for generated classes representing GLib structs.
-  class StructBase < BoxedBase
+  class StructBase < ClassBase
+    extend FFI::DataConverter
+    extend GirFFI::StructLikeBase
+
+    def initialize
+      @struct = self.class::Struct.new
+    end
+
+    # Wrap value and take ownership of it
+    def self.wrap_own(val)
+      wrap(val).tap { |it| it && it.to_ptr.autorelease = true }
+    end
   end
 end

data/lib/gir_ffi/struct_like_base.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+module GirFFI
+  # Base module providing class methods for generated classes representing GLib
+  # structs, unions and boxed types.
+  module StructLikeBase
+    def native_type
+      FFI::Type::Struct.new(self::Struct)
+    end
+
+    def to_ffi_type
+      self
+    end
+
+    # NOTE: Needed for JRuby's FFI
+    def to_native(value, _context)
+      value.struct
+    end
+
+    def get_value_from_pointer(pointer, offset)
+      pointer + offset
+    end
+
+    def size
+      self::Struct.size
+    end
+
+    def copy_value_to_pointer(value, pointer, offset = 0)
+      size = self::Struct.size
+      bytes = if value
+                value.to_ptr.read_bytes(size)
+              else
+                "\x00" * size
+              end
+      pointer.put_bytes offset, bytes, 0, size
+    end
+
+    # Create an unowned copy of the struct represented by val
+    def copy_from(val)
+      copy(from(val)).tap { |it| it && it.to_ptr.autorelease = false }
+    end
+
+    # Wrap an owned copy of the struct represented by val
+    def wrap_copy(val)
+      copy wrap(val)
+    end
+
+    # Create a copy of the struct represented by val
+    def copy(val)
+      return unless val
+      new.tap { |copy| copy_value_to_pointer(val, copy.to_ptr) }
+    end
+  end
+end

data/lib/gir_ffi/union_base.rb

@@ -3,6 +3,12 @@ require 'gir_ffi/boxed_base'
 
 module GirFFI
   # Base class for generated classes representing GLib unions.
-  class UnionBase < BoxedBase
+  class UnionBase < ClassBase
+    extend FFI::DataConverter
+    extend GirFFI::StructLikeBase
+
+    def initialize
+      @struct = self.class::Struct.new
+    end
   end
 end

data/lib/gir_ffi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # Current GirFFI version
 module GirFFI
-  VERSION = '0.9.5'.freeze
+  VERSION = '0.10.0.pre1'.freeze
 end

data/test/ffi-glib/destroy_notify_test.rb

@@ -6,8 +6,11 @@ describe GLib::DestroyNotify 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
+      GirFFI::CallbackBase::CALLBACKS[dummy_proc.object_id].wont_be_nil
+
+      user_data = GirFFI::ArgHelper.store dummy_proc
       GLib::DestroyNotify.default.call user_data
+
       GirFFI::CallbackBase::CALLBACKS[dummy_proc.object_id].must_be_nil
     end
   end

data/test/ffi-gobject/param_spec_test.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'gir_ffi_test_helper'
+
+require 'ffi-gobject'
+describe GObject::ParamSpec do
+  describe '#ref' do
+    it 'increases the ref count' do
+      pspec = GObject.param_spec_boolean('foo', 'foo bar',
+                                         'Boolean Foo Bar',
+                                         false,
+                                         readable: true, writable: true)
+
+      old = pspec.ref_count
+      pspec.ref
+      pspec.ref_count.must_equal old + 1
+    end
+  end
+end

data/test/gir_ffi/arg_helper_test.rb

@@ -24,4 +24,21 @@ describe GirFFI::ArgHelper do
       GirFFI::ArgHelper.cast_from_pointer(:guint32, ptr).must_equal(0xffffffff)
     end
   end
+
+  describe '.store' do
+    describe 'when called with nil' do
+      it 'returns a null pointer' do
+        GirFFI::ArgHelper.store(nil).must_be :null?
+      end
+    end
+
+    describe 'when called with a string' do
+      it 'stores the string in GirFFI::ArgHelper::OBJECT_STORE' do
+        str = 'Foo'
+        ptr = GirFFI::ArgHelper.store(str)
+        result = GirFFI::ArgHelper::OBJECT_STORE.fetch(ptr)
+        result.must_equal str
+      end
+    end
+  end
 end