gir_ffi 0.15.1 → 0.15.6

data/lib/gir_ffi/builders/user_defined_builder.rb

@@ -12,6 +12,7 @@ module GirFFI
       end
 
       def setup_class
+        check_ancestry
         setup_layout
         register_type
         setup_constants
@@ -26,6 +27,12 @@ module GirFFI
 
       private
 
+      def check_ancestry
+        unless klass < GirFFI::ObjectBase
+          raise ArgumentError, "#{klass} is not a GObject class"
+        end
+      end
+
       def register_type
         @gtype = GObject.type_register_static(parent_gtype.to_i,
                                               info.g_name,
@@ -98,7 +105,7 @@ module GirFFI
       end
 
       def class_size
-        parent_gtype.class_size + interface_gtypes.map(&:class_size).inject(0, :+)
+        parent_gtype.class_size + interface_gtypes.sum(&:class_size)
       end
 
       def setup_properties(object_class_ptr)

data/lib/gir_ffi/builders/vfunc_argument_builder.rb

@@ -9,7 +9,7 @@ module GirFFI
     class VFuncArgumentBuilder < CallbackArgumentBuilder
       def pre_conversion
         if ingoing_ref_needed?
-          super + ["#{pre_converted_name}.ref"]
+          super + ["#{pre_converted_name}&.ref"]
         else
           super
         end

data/lib/gir_ffi/callback_base.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "gir_ffi/type_base"
+require "set"
 
 module GirFFI
   # Base module for callbacks and vfuncs.
@@ -35,14 +36,14 @@ module GirFFI
       from_native ptr, nil
     end
 
-    CALLBACKS = {}
+    CALLBACKS = Set.new
 
     def self.store_callback(prc)
-      CALLBACKS[prc.object_id] = prc
+      CALLBACKS.add prc
     end
 
     def self.drop_callback(prc)
-      CALLBACKS.delete prc.object_id
+      CALLBACKS.delete prc
     end
 
     # Create Callback from a Proc. Makes sure arguments are properly wrapped,
@@ -57,11 +58,9 @@ module GirFFI
       return unless prc
 
       new do |*args|
-        begin
-          call_with_argument_mapping(prc, *args)
-        rescue StandardError => e
-          GLib::MainLoop.handle_exception e
-        end
+        call_with_argument_mapping(prc, *args)
+      rescue StandardError => e
+        GLib::MainLoop.handle_exception e
       end
     end
 

data/lib/gir_ffi/class_base.rb

@@ -18,6 +18,7 @@ module GirFFI
     GIR_FFI_BUILDER = Builders::NullClassBuilder.new
 
     attr_reader :struct
+
     def_delegators :@struct, :to_ptr
 
     def setup_and_call(method, arguments, &block)

data/lib/gir_ffi/core.rb

@@ -28,8 +28,23 @@ module GirFFI
       Builder.build_module namespace, version
     end
 
-    def define_type(klass, &block)
-      info = UserDefinedObjectInfo.new(klass, &block)
+    def define_type(klass)
+      unless klass < GirFFI::ObjectBase
+        raise ArgumentError, "#{klass} is not a GObject class"
+      end
+
+      klass.prepare_user_defined_class
+      info = klass.gir_info
+
+      unless info.is_a? UserDefinedObjectInfo
+        raise ArgumentError, "#{klass} is not a user-defined class"
+      end
+
+      if block_given?
+        warn "Using define_type with a block is deprecated." \
+          " Call the relevant functions inside the class definition instead."
+        yield info
+      end
       Builders::UserDefinedBuilder.new(info).build_class
 
       klass.gtype

data/lib/gir_ffi/glib_error.rb

@@ -4,8 +4,7 @@ module GirFFI
   # Exception class to be raised whenever an error is signaled through
   # GLib::Error.
   class GLibError < RuntimeError
-    attr_reader :domain_quark
-    attr_reader :code
+    attr_reader :domain_quark, :code
 
     def initialize(g_error)
       @domain_quark = g_error.domain

data/lib/gir_ffi/in_pointer.rb

@@ -67,6 +67,8 @@ module GirFFI
           from_utf8_array ary
         when :gboolean
           from_boolean_array ary
+        when :guint8
+          from_char_array ary
         else
           from_basic_type_array type, ary
         end
@@ -92,6 +94,11 @@ module GirFFI
         from_basic_type_array :int, ary.map { |val| val ? 1 : 0 }
       end
 
+      def from_char_array(ary)
+        ary = ary.bytes if ary.is_a? String
+        from_basic_type_array :int8, ary
+      end
+
       def from_pointer_array(type, ary)
         from_basic_type_array :pointer, ary.map { |elem| from type, elem }
       end

data/lib/gir_ffi/object_base.rb

@@ -81,5 +81,32 @@ module GirFFI
         it < GirFFI::ObjectBase || it.singleton_class.include?(InterfaceBase)
       end
     end
+
+    def self.prepare_user_defined_class
+      return if const_defined? :GIR_INFO, false
+
+      info = UserDefinedObjectInfo.new(self)
+      const_set :GIR_INFO, info
+    end
+
+    def self.install_property(param_spec)
+      if const_defined? :GIR_FFI_BUILDER, false
+        raise "Installing a property in a class that is already set up is not supported"
+      end
+
+      prepare_user_defined_class
+
+      gir_info.install_property(param_spec)
+    end
+
+    def self.install_vfunc_implementation(name, implementation = nil)
+      if const_defined? :GIR_FFI_BUILDER, false
+        raise "Installing a property in a class that is already set up is not supported"
+      end
+
+      prepare_user_defined_class
+
+      gir_info.install_vfunc_implementation(name, implementation)
+    end
   end
 end

data/lib/gir_ffi/return_value_info.rb

@@ -3,8 +3,7 @@
 module GirFFI
   # Represents a return value with the same interface as IArgInfo
   class ReturnValueInfo
-    attr_reader :argument_type
-    attr_reader :ownership_transfer
+    attr_reader :argument_type, :ownership_transfer
 
     def initialize(type, ownership_transfer, skip)
       @argument_type = type

data/lib/gir_ffi/struct_base.rb

@@ -4,14 +4,6 @@ require "gir_ffi/struct_like_base"
 
 module GirFFI
   # Base class for generated classes representing GLib structs.
-  class StructBase < ClassBase
-    extend FFI::DataConverter
-    include GirFFI::StructLikeBase
-
-    def initialize
-      @struct = self.class::Struct.new
-      @struct.owned = true
-      @struct.to_ptr.autorelease = false
-    end
+  class StructBase < StructLikeBase
   end
 end

data/lib/gir_ffi/struct_like_base.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
 module GirFFI
-  # Base module providing class methods for generated classes representing GLib
+  # Base class providing methods for generated classes representing GLib
   # structs, unions and boxed types.
-  module StructLikeBase
-    def self.included(base)
-      base.extend ClassMethods
+  class StructLikeBase < ClassBase
+    extend FFI::DataConverter
+
+    def initialize
+      store_pointer(nil)
+      struct.owned = true
+      struct.to_ptr.autorelease = false
     end
 
     # Class methods for struct-like classes.
-    module ClassMethods
+    class << self
       def native_type
         FFI::Type::Struct.new(self::Struct)
       end

data/lib/gir_ffi/type_map.rb

@@ -22,6 +22,7 @@ module GirFFI
       array:     :pointer,
       c:         GirFFI::SizedArray,
       utf8:      :pointer,
+      filename:  :pointer,
       GType:     gsize_type,
       gboolean:  GirFFI::Boolean,
       gunichar:  :uint32,

data/lib/gir_ffi/unintrospectable_type_info.rb

@@ -56,7 +56,7 @@ module GirFFI
 
     # TODO: Create custom class that includes the interfaces instead
     def class_struct
-      parent.class_struct
+      nil
     end
   end
 end

data/lib/gir_ffi/union_base.rb

@@ -4,14 +4,6 @@ require "gir_ffi/boxed_base"
 
 module GirFFI
   # Base class for generated classes representing GLib unions.
-  class UnionBase < ClassBase
-    extend FFI::DataConverter
-    include GirFFI::StructLikeBase
-
-    def initialize
-      @struct = self.class::Struct.new
-      @struct.owned = true
-      @struct.to_ptr.autorelease = false
-    end
+  class UnionBase < StructLikeBase
   end
 end

data/lib/gir_ffi/user_defined_object_info.rb

@@ -13,6 +13,8 @@ module GirFFI
       @klass = klass
       @properties = []
       @vfunc_implementations = []
+
+      # FIXME: Limit access to only install_property and install_vfunc_implementation.
       yield self if block_given?
     end
 
@@ -25,7 +27,6 @@ module GirFFI
     end
 
     def install_vfunc_implementation(name, implementation = nil)
-      implementation ||= ->(obj, *args) { obj.public_send name, *args }
       @vfunc_implementations << VFuncImplementation.new(name, implementation)
     end
 
@@ -51,7 +52,7 @@ module GirFFI
 
     # TODO: Create custom class that includes the interfaces instead
     def class_struct
-      parent.class_struct
+      nil
     end
 
     def interfaces

data/lib/gir_ffi/version.rb

@@ -2,5 +2,5 @@
 
 # Current GirFFI version
 module GirFFI
-  VERSION = "0.15.1"
+  VERSION = "0.15.6"
 end

data/lib/gir_ffi/vfunc_implementation.rb

@@ -6,6 +6,7 @@ module GirFFI
     attr_reader :name, :implementation
 
     def initialize(name, implementation)
+      implementation ||= ->(obj, *args) { obj.public_send name, *args }
       @name = name
       @implementation = implementation
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gir_ffi
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.15.6
 platform: ruby
 authors:
 - Matijs van Zuijlen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-20 00:00:00.000000000 Z
+date: 2021-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-manifest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
@@ -94,25 +122,81 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.21.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
-description: |2
-      GirFFI creates bindings for GObject-based libraries at runtime based on introspection
-      data provided by the GObject Introspection Repository (GIR) system. Bindings are created
-      at runtime and use FFI to interface with the C libraries. In cases where the GIR does not
-      provide enough or correct information to create sane bindings, overrides may be created.
+        version: 0.21.0
+description: |
+  GirFFI creates bindings for GObject-based libraries at runtime based on introspection
+  data provided by the GObject Introspection Repository (GIR) system. Bindings are created
+  at runtime and use FFI to interface with the C libraries. In cases where the GIR does not
+  provide enough or correct information to create sane bindings, overrides may be created.
 email:
 - matijs@matijs.net
 executables: []
@@ -126,10 +210,10 @@ files:
 - COPYING.LIB
 - Changelog.md
 - DESIGN.md
-- Gemfile
 - README.md
-- Rakefile
 - TODO.md
+- docs/Documentation.md
+- docs/Subclassing.md
 - examples/clutter.rb
 - examples/main_loop.rb
 - lib/ffi-glib.rb
@@ -305,135 +389,14 @@ files:
 - lib/gir_ffi/version.rb
 - lib/gir_ffi/vfunc_implementation.rb
 - lib/gir_ffi/zero_terminated.rb
-- tasks/test.rake
-- test/base_test_helper.rb
-- test/ffi-glib/array_test.rb
-- test/ffi-glib/byte_array_test.rb
-- test/ffi-glib/bytes_test.rb
-- test/ffi-glib/closure_test.rb
-- test/ffi-glib/destroy_notify_test.rb
-- test/ffi-glib/hash_table_test.rb
-- test/ffi-glib/list_test.rb
-- test/ffi-glib/main_loop_test.rb
-- test/ffi-glib/ptr_array_test.rb
-- test/ffi-glib/ruby_closure_test.rb
-- test/ffi-glib/s_list_test.rb
-- test/ffi-glib/strv_test.rb
-- test/ffi-glib/variant_test.rb
-- test/ffi-gobject/gobject_test.rb
-- test/ffi-gobject/object_class_test.rb
-- test/ffi-gobject/object_test.rb
-- test/ffi-gobject/param_spec_test.rb
-- test/ffi-gobject/value_test.rb
-- test/ffi-gobject_introspection/gobject_type_init_test.rb
-- test/ffi-gobject_introspection/i_base_info_test.rb
-- test/ffi-gobject_introspection/i_constant_info_test.rb
-- test/ffi-gobject_introspection/i_enum_info_test.rb
-- test/ffi-gobject_introspection/i_function_info_test.rb
-- test/ffi-gobject_introspection/i_interface_info_test.rb
-- test/ffi-gobject_introspection/i_object_info_test.rb
-- test/ffi-gobject_introspection/i_property_info_test.rb
-- test/ffi-gobject_introspection/i_registered_type_info_test.rb
-- test/ffi-gobject_introspection/i_repository_test.rb
-- test/ffi-gobject_introspection/i_struct_info_test.rb
-- test/ffi-gobject_introspection/i_type_info_test.rb
-- test/ffi-gobject_introspection/i_union_info_test.rb
-- test/ffi-gobject_introspection/i_vfunc_info_test.rb
-- test/ffi-gobject_introspection/lib_test.rb
-- test/ffi-gobject_introspection/strv_test.rb
-- test/ffi-gobject_test.rb
-- test/gir_ffi/allocation_helper_test.rb
-- test/gir_ffi/arg_helper_test.rb
-- test/gir_ffi/boolean_test.rb
-- test/gir_ffi/boxed_base_test.rb
-- test/gir_ffi/builder_test.rb
-- test/gir_ffi/builders/argument_builder_test.rb
-- test/gir_ffi/builders/base_argument_builder_test.rb
-- test/gir_ffi/builders/callback_argument_builder_test.rb
-- test/gir_ffi/builders/callback_builder_test.rb
-- test/gir_ffi/builders/callback_return_value_builder_test.rb
-- test/gir_ffi/builders/constant_builder_test.rb
-- test/gir_ffi/builders/constructor_builder_test.rb
-- test/gir_ffi/builders/enum_builder_test.rb
-- test/gir_ffi/builders/field_builder_test.rb
-- test/gir_ffi/builders/function_builder_test.rb
-- test/gir_ffi/builders/initializer_builder_test.rb
-- test/gir_ffi/builders/interface_builder_test.rb
-- test/gir_ffi/builders/module_builder_test.rb
-- test/gir_ffi/builders/object_builder_test.rb
-- test/gir_ffi/builders/property_builder_test.rb
-- test/gir_ffi/builders/registered_type_builder_test.rb
-- test/gir_ffi/builders/return_value_builder_test.rb
-- test/gir_ffi/builders/signal_closure_builder_test.rb
-- test/gir_ffi/builders/struct_builder_test.rb
-- test/gir_ffi/builders/unintrospectable_boxed_builder_test.rb
-- test/gir_ffi/builders/unintrospectable_builder_test.rb
-- test/gir_ffi/builders/union_builder_test.rb
-- test/gir_ffi/builders/user_defined_builder_test.rb
-- test/gir_ffi/builders/vfunc_argument_builder_test.rb
-- test/gir_ffi/builders/vfunc_builder_test.rb
-- test/gir_ffi/callback_base_test.rb
-- test/gir_ffi/class_base_test.rb
-- test/gir_ffi/core_test.rb
-- test/gir_ffi/enum_base_test.rb
-- test/gir_ffi/error_type_info_test.rb
-- test/gir_ffi/ffi_ext/pointer_test.rb
-- test/gir_ffi/g_type_test.rb
-- test/gir_ffi/in_pointer_test.rb
-- test/gir_ffi/info_ext/i_callable_info_test.rb
-- test/gir_ffi/info_ext/i_callback_info_test.rb
-- test/gir_ffi/info_ext/i_field_info_test.rb
-- test/gir_ffi/info_ext/i_function_info_test.rb
-- test/gir_ffi/info_ext/i_signal_info_test.rb
-- test/gir_ffi/info_ext/i_type_info_test.rb
-- test/gir_ffi/info_ext/i_unresolved_info_test.rb
-- test/gir_ffi/info_ext/safe_constant_name_test.rb
-- test/gir_ffi/info_ext/safe_function_name_test.rb
-- test/gir_ffi/interface_base_test.rb
-- test/gir_ffi/method_stubber_test.rb
-- test/gir_ffi/object_base_test.rb
-- test/gir_ffi/object_store_test.rb
-- test/gir_ffi/receiver_argument_info_test.rb
-- test/gir_ffi/sized_array_test.rb
-- test/gir_ffi/struct_base_test.rb
-- test/gir_ffi/struct_like_base_test.rb
-- test/gir_ffi/type_map_test.rb
-- test/gir_ffi/unintrospectable_type_info_test.rb
-- test/gir_ffi/union_base_test.rb
-- test/gir_ffi/user_defined_object_info_test.rb
-- test/gir_ffi/user_defined_property_info_test.rb
-- test/gir_ffi/variable_name_generator_test.rb
-- test/gir_ffi/version_test.rb
-- test/gir_ffi/zero_terminated_test.rb
-- test/gir_ffi_test_helper.rb
-- test/integration/callback_exceptions_test.rb
-- test/integration/derived_classes_test.rb
-- test/integration/generated_everything_test.rb
-- test/integration/generated_gimarshallingtests_test.rb
-- test/integration/generated_gio_test.rb
-- test/integration/generated_glib_test.rb
-- test/integration/generated_gobject_test.rb
-- test/integration/generated_gst_test.rb
-- test/integration/generated_gtk_source_test.rb
-- test/integration/generated_gtop_test.rb
-- test/integration/generated_pango_ft2_test.rb
-- test/integration/generated_pango_test.rb
-- test/integration/generated_regress_test.rb
-- test/integration/generated_secret_test.rb
-- test/integration/generated_utility_test.rb
-- test/integration/generated_warnlib_test.rb
-- test/integration/method_lookup_test.rb
-- test/introspection_test_helper.rb
-- test/lib/Makefile.am
-- test/lib/autogen.sh
-- test/lib/configure.ac
-- test/lib/m4/jhflags.m4
-- test/minitest/stats_plugin.rb
 homepage: http://www.github.com/mvz/ruby-gir-ffi
 licenses:
 - LGPL-2.1+
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: http://www.github.com/mvz/ruby-gir-ffi
+  source_code_uri: https://github.com/mvz/gir_ffi
+  changelog_uri: https://github.com/mvz/gir_ffi/blob/master/Changelog.md
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -443,15 +406,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: FFI-based GObject binding using the GObject Introspection Repository
 test_files: []