gir_ffi 0.10.2 → 0.11.0

data/lib/gir_ffi/core.rb

@@ -2,10 +2,10 @@
 require 'ffi'
 require 'ffi/bit_masks'
 
-require 'gir_ffi-base'
-
 require 'ffi-gobject_introspection'
 
+require 'gir_ffi-base'
+
 require 'gir_ffi/ffi_ext'
 require 'gir_ffi/class_base'
 require 'gir_ffi/type_map'
@@ -16,22 +16,25 @@ require 'gir_ffi/sized_array'
 require 'gir_ffi/zero_terminated'
 require 'gir_ffi/arg_helper'
 require 'gir_ffi/builder'
-require 'gir_ffi/user_defined_type_info'
+require 'gir_ffi/user_defined_object_info'
 require 'gir_ffi/builders/user_defined_builder'
 require 'gir_ffi/version'
 
-# Main module containing classes and modules needed for generating GLib and
-# GObject bindings.
 module GirFFI
-  def self.setup(namespace, version = nil)
-    namespace = namespace.to_s
-    GirFFI::Builder.build_module namespace, version
-  end
+  # Core GirFFI interface.
+  module Core
+    def setup(namespace, version = nil)
+      namespace = namespace.to_s
+      Builder.build_module namespace, version
+    end
 
-  def self.define_type(klass, &block)
-    info = UserDefinedTypeInfo.new(klass, &block)
-    Builders::UserDefinedBuilder.new(info).build_class
+    def define_type(klass, &block)
+      info = UserDefinedObjectInfo.new(klass, &block)
+      Builders::UserDefinedBuilder.new(info).build_class
 
-    klass.gtype
+      klass.gtype
+    end
   end
 end
+
+GirFFI.extend GirFFI::Core

data/lib/gir_ffi/enum_base.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
-require 'gir_ffi/registered_type_base'
+require 'gir_ffi/enum_like_base'
 
 module GirFFI
   # Base module for enums.
   module EnumBase
-    include FFI::DataConverter
-    include RegisteredTypeBase
+    include EnumLikeBase
 
     def native_type
       self::Enum.native_type
@@ -22,43 +21,5 @@ module GirFFI
     def [](arg)
       self::Enum[arg]
     end
-
-    def wrap(arg)
-      self[arg]
-    end
-
-    def from(arg)
-      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
-
-    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/enum_like_base.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+require 'gir_ffi/registered_type_base'
+
+module GirFFI
+  # Base module for enums and flags.
+  module EnumLikeBase
+    include FFI::DataConverter
+    include RegisteredTypeBase
+
+    def wrap(arg)
+      self[arg]
+    end
+
+    def from(arg)
+      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
+
+    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/ffi_ext/pointer.rb

@@ -25,7 +25,7 @@ module GirFFI
   end
 end
 
-FFI::Pointer.send :include, GirFFI::FFIExt::Pointer
+FFI::Pointer.prepend GirFFI::FFIExt::Pointer
 
 FFI::Pointer.class_eval do
   case FFI.type_size(:size_t)

data/lib/gir_ffi/flags_base.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
-require 'gir_ffi/registered_type_base'
+require 'gir_ffi/enum_like_base'
 
 module GirFFI
   # Base module for flags.
   module FlagsBase
-    include FFI::DataConverter
-    include RegisteredTypeBase
+    include EnumLikeBase
 
     def native_type
       self::BitMask.native_type
@@ -26,43 +25,5 @@ module GirFFI
     def [](arg)
       self::BitMask[arg]
     end
-
-    def wrap(arg)
-      self[arg]
-    end
-
-    def from(arg)
-      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
-
-    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_out_pointer.rb

@@ -39,7 +39,7 @@ module GirFFI
 
     def self.allocate_new(type)
       ffi_type = TypeMap.type_specification_to_ffi_type type
-      ptr = AllocationHelper.allocate(ffi_type)
+      ptr = FFI::MemoryPointer.new(ffi_type)
       new type, ptr
     end
 

data/lib/gir_ffi/in_pointer.rb

@@ -103,10 +103,10 @@ module GirFFI
       def from_basic_type_array(type, ary)
         ffi_type = TypeMap.type_specification_to_ffi_type type
         type_size = FFI.type_size(ffi_type)
-        block = FFI::MemoryPointer.new type_size * (ary.length + 1)
-        block.autorelease = false
-        block.send "put_array_of_#{ffi_type}", 0, ary
-        block
+        FFI::MemoryPointer.new(type_size * (ary.length + 1)).tap do |block|
+          block.autorelease = false
+          block.send "put_array_of_#{ffi_type}", 0, ary
+        end
       end
     end
   end

data/lib/gir_ffi/info_ext/i_type_info.rb

@@ -55,10 +55,14 @@ module GirFFI
         tag == :interface && interface.info_type
       end
 
+      def hidden_struct_type?
+        flattened_tag == :struct && interface.size.zero?
+      end
+
       def tag_or_class
         base = case tag
                when :interface
-                 Builder.build_class interface
+                 interface_class
                when :ghash
                  [tag, *element_type]
                else
@@ -71,6 +75,10 @@ module GirFFI
         end
       end
 
+      def interface_class
+        Builder.build_class interface if tag == :interface
+      end
+
       TAG_TO_WRAPPER_CLASS_MAP = {
         array:           'GLib::Array',
         byte_array:      'GLib::ByteArray',
@@ -88,11 +96,12 @@ module GirFFI
 
       # TODO: Use class rather than class name
       def argument_class_name
-        if tag == :interface
-          interface.full_type_name
-        else
+        interface_class_name ||
           TAG_TO_WRAPPER_CLASS_MAP[flattened_tag]
-        end
+      end
+
+      def interface_class_name
+        interface.full_type_name if tag == :interface
       end
 
       def to_ffi_type

data/lib/gir_ffi/info_ext/i_vfunc_info.rb

@@ -13,6 +13,14 @@ module GirFFI
       def return_ffi_type
         return_type.to_callback_ffi_type
       end
+
+      def invoker_name
+        invoker && invoker.name
+      end
+
+      def has_invoker?
+        invoker
+      end
     end
   end
 end

data/lib/gir_ffi/module_base.rb

@@ -8,6 +8,10 @@ module GirFFI
       send method, *arguments, &block
     end
 
+    def respond_to_missing?(method, *)
+      gir_ffi_builder.method_available? method
+    end
+
     def const_missing(classname)
       load_class(classname)
     end

data/lib/gir_ffi/receiver_argument_info.rb

@@ -14,8 +14,8 @@ module GirFFI
       :in
     end
 
+    # Assume we don't need to increase the refcount for the receiver argument.
     def ownership_transfer
-      # FIXME: Make an informed choice for this.
       :everything
     end
 

data/lib/gir_ffi/sized_array.rb

@@ -16,7 +16,7 @@ module GirFFI
     end
 
     def index(idx)
-      ptr = GirFFI::InOutPointer.new element_type, @pointer + idx * element_size
+      ptr = InOutPointer.new element_type, @pointer + idx * element_size
       ptr.to_ruby_value
     end
 
@@ -27,7 +27,7 @@ module GirFFI
     end
 
     def ==(other)
-      to_a == other.to_a
+      to_a.eql? other.to_a
     end
 
     def size_in_bytes
@@ -40,7 +40,7 @@ module GirFFI
 
     def self.copy_value_to_pointer(value, pointer)
       size = value.size_in_bytes
-      pointer.put_bytes(0, value.to_ptr.read_bytes(size), 0, size)
+      pointer.put_bytes(0, value.to_ptr.read_bytes(size))
     end
 
     def self.wrap(element_type, size, pointer)
@@ -50,7 +50,7 @@ module GirFFI
     private
 
     def element_ffi_type
-      @element_ffi_type ||= GirFFI::TypeMap.type_specification_to_ffi_type element_type
+      @element_ffi_type ||= TypeMap.type_specification_to_ffi_type element_type
     end
 
     def element_size
@@ -101,12 +101,12 @@ module GirFFI
       def from_enumerable(element_type, expected_size, arr)
         size = arr.size
         check_size expected_size, size
-        ptr = GirFFI::InPointer.from_array element_type, arr
+        ptr = InPointer.from_array element_type, arr
         wrap element_type, size, ptr
       end
 
       def check_size(expected_size, size)
-        if expected_size > 0 && size != expected_size
+        if expected_size != -1 && size != expected_size
           raise ArgumentError, "Expected size #{expected_size}, got #{size}"
         end
       end

data/lib/gir_ffi/struct_base.rb

@@ -5,17 +5,12 @@ module GirFFI
   # Base class for generated classes representing GLib structs.
   class StructBase < ClassBase
     extend FFI::DataConverter
-    extend GirFFI::StructLikeBase
+    include GirFFI::StructLikeBase
 
     def initialize
       @struct = self.class::Struct.new
       @struct.owned = true
       @struct.to_ptr.autorelease = false
     end
-
-    # Wrap value and take ownership of it
-    def self.wrap_own(val)
-      own wrap(val)
-    end
   end
 end

data/lib/gir_ffi/struct_like_base.rb

@@ -3,62 +3,71 @@ 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)
+    def self.included(base)
+      base.extend ClassMethods
     end
 
-    def to_ffi_type
-      self
-    end
+    # Class methods for struct-like classes.
+    module ClassMethods
+      def native_type
+        FFI::Type::Struct.new(self::Struct)
+      end
 
-    # NOTE: Needed for JRuby's FFI
-    def to_native(value, _context)
-      value.struct
-    end
+      def to_ffi_type
+        self
+      end
 
-    def get_value_from_pointer(pointer, offset)
-      pointer + offset
-    end
+      # NOTE: Needed for JRuby's FFI
+      def to_native(value, _context)
+        value.struct
+      end
 
-    def size
-      self::Struct.size
-    end
+      def get_value_from_pointer(pointer, offset)
+        pointer + offset
+      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
+      def size
+        self::Struct.size
+      end
 
-    # Create an unowned copy of the struct represented by val
-    def copy_from(val)
-      disown copy from(val)
-    end
+      def copy_value_to_pointer(value, pointer, offset = 0)
+        bytes = value.to_ptr.read_bytes(size)
+        pointer.put_bytes offset, bytes
+      end
 
-    # Wrap an owned copy of the struct represented by val
-    def wrap_copy(val)
-      own copy wrap(val)
-    end
+      # Create an unowned copy of the struct represented by val
+      def copy_from(val)
+        disown copy from(val)
+      end
 
-    def own(val)
-      val.struct.owned = true if val
-      val
-    end
+      # Wrap an owned copy of the struct represented by val
+      def wrap_copy(val)
+        own copy(val)
+      end
 
-    def disown(val)
-      val.struct.owned = false if val
-      val
-    end
+      # Wrap value and take ownership of it
+      def wrap_own(val)
+        own wrap(val)
+      end
+
+      private
+
+      def own(val)
+        val.struct.owned = true if val
+        val
+      end
+
+      def disown(val)
+        val.struct.owned = nil if val
+        val
+      end
 
-    # Create a copy of the struct represented by val
-    def copy(val)
-      return unless val
-      new.tap do |copy|
-        copy_value_to_pointer(val, copy.to_ptr)
+      # Create a copy of the struct represented by val
+      def copy(val)
+        return unless val
+        new.tap do |copy|
+          copy_value_to_pointer(val, copy.to_ptr)
+        end
       end
     end
   end

data/lib/gir_ffi/type_map.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'gir_ffi/boolean'
 require 'gir_ffi/sized_array'
 
 module GirFFI
@@ -14,25 +15,27 @@ module GirFFI
       glist:     :pointer,
       gslist:    :pointer,
       strv:      :pointer,
-      object:    :pointer,
-      struct:    :pointer,
+      interface: :pointer,
       error:     :pointer,
       ptr_array: :pointer,
       array:     :pointer,
       c:         GirFFI::SizedArray,
       utf8:      :pointer,
       GType:     gsize_type,
-      gboolean:  GLib::Boolean,
+      gboolean:  GirFFI::Boolean,
       gunichar:  :uint32,
       gint8:     :int8,
       guint8:    :uint8,
       gint16:    :int16,
       guint16:   :uint16,
       gint:      :int,
+      guint:     :uint,
       gint32:    :int32,
       guint32:   :uint32,
       gint64:    :int64,
       guint64:   :uint64,
+      glong:     :long,
+      gulong:    :ulong,
       gsize:     gsize_type,
       gfloat:    :float,
       gdouble:   :double,
@@ -44,10 +47,6 @@ module GirFFI
       TAG_TYPE_MAP[sym] || sym
     end
 
-    def self.type_specification_to_ffitype(type)
-      type_specification_to_ffi_type type
-    end
-
     def self.type_specification_to_ffi_type(type)
       case type
       when Module

data/lib/gir_ffi/union_base.rb

@@ -5,7 +5,7 @@ module GirFFI
   # Base class for generated classes representing GLib unions.
   class UnionBase < ClassBase
     extend FFI::DataConverter
-    extend GirFFI::StructLikeBase
+    include GirFFI::StructLikeBase
 
     def initialize
       @struct = self.class::Struct.new

data/lib/gir_ffi/{user_defined_type_info.rb → user_defined_object_info.rb}

@@ -5,8 +5,7 @@ require 'gir_ffi/vfunc_implementation'
 module GirFFI
   # Represents a user defined type, conforming, as needed, to the interface of
   # GObjectIntrospection::IObjectInfo.
-  # TODO: Rename to UserDefinedObjectInfo
-  class UserDefinedTypeInfo
+  class UserDefinedObjectInfo
     attr_reader :properties, :vfunc_implementations
 
     def initialize(klass)

data/lib/gir_ffi/user_defined_property_info.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 module GirFFI
-  # Represents a property of a user defined type, conforming, as needed, to the
-  # interface of GObjectIntrospection::IPropertyInfo.
+  # Represents a property of a user defined type.
   class UserDefinedPropertyInfo
     def initialize(param_spec)
       @param_spec = param_spec
@@ -12,5 +11,84 @@ module GirFFI
     def name
       @param_spec.get_name
     end
+
+    def accessor_name
+      @param_spec.accessor_name
+    end
+
+    def writable?
+      @param_spec.flags[:writable]
+    end
+
+    def value_type
+      @param_spec.value_type
+    end
+
+    # TODO: Unify with InfoExt::ITypeInfo.flattened_tag_to_gtype_map
+    G_TYPE_POINTER_MAP = {
+      GObject::TYPE_BOOLEAN => false,
+      GObject::TYPE_CHAR => false,
+      GObject::TYPE_UCHAR => false,
+      GObject::TYPE_FLOAT => false,
+      GObject::TYPE_DOUBLE => false,
+      GObject::TYPE_INT => false,
+      GObject::TYPE_UINT => false,
+      GObject::TYPE_LONG => false,
+      GObject::TYPE_ULONG => false,
+      GObject::TYPE_INT64 => false,
+      GObject::TYPE_UINT64 => false,
+      GObject::TYPE_ENUM => false,
+      GObject::TYPE_FLAGS => false,
+      GObject::TYPE_STRING => true,
+      GObject::TYPE_BOXED => true,
+      GObject::TYPE_OBJECT => true
+    }.freeze
+
+    def pointer_type?
+      G_TYPE_POINTER_MAP.fetch(fundamental_value_type)
+    end
+
+    # TODO: Unify with InfoExt::ITypeInfo.flattened_tag_to_gtype_map
+    G_TYPE_TAG_MAP = {
+      GObject::TYPE_BOOLEAN => :gboolean,
+      GObject::TYPE_CHAR => :gint8,
+      GObject::TYPE_UCHAR => :guint8,
+      GObject::TYPE_FLOAT => :gfloat,
+      GObject::TYPE_DOUBLE => :gdouble,
+      GObject::TYPE_INT => :gint,
+      GObject::TYPE_UINT => :guint,
+      GObject::TYPE_LONG => :glong,
+      GObject::TYPE_ULONG => :gulong,
+      GObject::TYPE_INT64 => :gint64,
+      GObject::TYPE_UINT64 => :guint64,
+      GObject::TYPE_ENUM => :interface,
+      GObject::TYPE_FLAGS => :interface,
+      GObject::TYPE_STRING => :utf8,
+      GObject::TYPE_BOXED => :interface,
+      GObject::TYPE_OBJECT => :interface
+    }.freeze
+
+    def type_tag
+      G_TYPE_TAG_MAP.fetch(fundamental_value_type)
+    end
+
+    G_TYPE_INTERFACE_TAG_MAP = {
+      GObject::TYPE_ENUM => :enum,
+      GObject::TYPE_FLAGS => :flags,
+      GObject::TYPE_BOXED => :struct,
+      GObject::TYPE_OBJECT => :object
+    }.freeze
+
+    def interface_type_tag
+      G_TYPE_INTERFACE_TAG_MAP.fetch(fundamental_value_type)
+    end
+
+    def fundamental_value_type
+      @fundamental_value_type ||= GObject.type_fundamental value_type
+    end
+
+    def ffi_type
+      GirFFI::TypeMap.map_basic_type(type_tag)
+    end
   end
 end

data/lib/gir_ffi/version.rb

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