gir_ffi 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c32084045b640a22901bdd0d256ce8b8df1ace345930d3e4fccfd0e598b82b19
-  data.tar.gz: 5ac1e06a4dd28b4589ca93e30c48218a4cffb40f18d9f8c87859fdd76460fc8c
+  metadata.gz: 99e99f94ba677daacfe98552b91f5221dea70d33dd992ac53e223e4ff05df898
+  data.tar.gz: d83b543e6408259e2fa9067faa74c393e117e94148a7d37b7825cfe840537d8e
 SHA512:
-  metadata.gz: f70592c52c01f747ca9370007783231007ef535a0039337aaf42e46a17acbf2a54178b33c591ca8658e040496bb66a34ffd1f8126b2b323470783b97418418ae
-  data.tar.gz: fd92518d3541a1c46ebfe4758af76e8f746cf7ae355797a7f5736cdb4bc4b8444f6e9b4be7bf08712155759b11e5d697c2bdb522f3a4241337446204e5fb13c3
+  metadata.gz: '02840b2cb293bd64f478f023d7267d20f37f35c24a3a15c9569a04e8f4095cb297d5e9319bd55f1105d8d4cd961c9cab7cc2b01092b1c822f04dab7dc70e9023'
+  data.tar.gz: 331e901b2c3c94800ad52576dd9127563ae9d41657f947be0543f7ad765e55d0bd64b2ad7642c58b6e36f243d4f5d719047de6d10d15c369cbc49e724b378bd4

data/Changelog.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.15.0 / 2019-10-19
+
+* Drop support for gobject-introspection below 1.46, the version available in
+  Ubuntu Xenial.
+* Merge extended property getter and setter into regular ones. This means you
+  can always just use `#get_property` and `#set_property`. The methods
+  `#get_property_extended` and `#set_property_extended` are deprecated and will
+  be removed in GirFFI version 0.16 or later.
+* Support setting ByteArray properties directly with string values.
+* Target Ruby 2.4+
+* Implement getting and setting of flag properties and GValues.
+* Add support for basic hashtable values larger than pointer.
+* Support unintrospectable classes not derived from GObject but from some other
+  fundamental object type.
+* Make GPtrArray work with boxed types.
+* Do not try to ref method reciever for struct instance methods marking the
+  instance receiver as transfer `:everything`.
+* Support signals with GError arguments.
+* Cache various methods on IBaseInfo and its subclasses.
+* Generate aliases for accessor methods instead of relying on `method_missing`.
+
 ## 0.14.1 / 2018-09-27
 
 * Add enum values as constants in the generated module.

data/Gemfile

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # The gem's dependencies are specified in gir_ffi.gemspec
 gemspec
 
-gem 'pry', '~> 0.11.0'
+gem "pry", "~> 0.12.0"
+gem "ruby-prof", platform: :mri
+gem "test-prof", platform: :mri
 
-if ENV['CI']
-  gem 'coveralls', group: :development if ENV['TRAVIS_RUBY_VERSION'] == '2.4'
+if ENV["CI"]
+  gem "coveralls", group: :development if ENV["TRAVIS_RUBY_VERSION"] == "2.4"
 end

data/README.md

@@ -53,7 +53,7 @@ examples can be found in `gir_ffi-gtk` and `gir_ffi-gst`.
 
 ## Requirements
 
-GirFFI is supported on CRuby 2.2, 2.3, 2.4 and 2.5, and JRuby 9.1 and 9.2
+GirFFI is supported on CRuby 2.4, 2.5 and 2.6, and JRuby 9.2.
 
 You will also need gobject-introspection installed with some
 introspection data.
@@ -63,15 +63,15 @@ available under the name ending in plain `.so`. If GirFFI complains that it
 cannot find the library, try installing development packages for those
 libraries.
 
-GirFFI should work with gobject-introspection 1.32.0 and up.
+GirFFI should work with gobject-introspection 1.46.0 and up.
 
 On Debian and Ubuntu, installing `libgirepository1.0-1` and `gir1.2-glib-2.0`
 should be enough to use GirFFI in your application.
 
 To run the tests, you should additionally install `libgirepository1.0-dev`,
 `libcairo2-dev`, `gobject-introspection`, `gir1.2-gtop-2.0`, `gir1.2-gtk-3.0`,
-`gir1.2-pango-1.0`, `gir1.2-secret-1` and `gir1.2-gstreamer-1.0`. This should
-be enough to get `rake test` working.
+`gir1.2-gtksource-3.0`, `gir1.2-pango-1.0`, `gir1.2-secret-1` and
+`gir1.2-gstreamer-1.0`. This should be enough to get `rake test` working.
 
 GirFFI has not been tested on Mac OS X or Microsoft Windows. YMMV.
 

data/Rakefile

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'rake/clean'
-require 'bundler/gem_tasks'
+require "rake/clean"
+require "bundler/gem_tasks"
 
-load 'tasks/test.rake'
+load "tasks/test.rake"
 
-task default: 'test:all'
-task default: 'test:features'
+task default: "test:all"
+task default: "test:features"

data/lib/ffi-glib/array.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'ffi-glib/container_class_methods'
-require 'ffi-glib/array_methods'
+require "ffi-glib/container_class_methods"
+require "gir_ffi/array_element_convertor"
 
 GLib.load_class :Array
 
@@ -10,7 +10,6 @@ module GLib
   # be necessary to create objects of this class from Ruby directly.
   class Array
     include Enumerable
-    include ArrayMethods
     extend ContainerClassMethods
 
     attr_reader :element_type
@@ -70,6 +69,17 @@ module GLib
       self
     end
 
+    # Re-implementation of the g_array_index macro
+    def index(idx)
+      unless (0...length).cover? idx
+        raise IndexError, "Index #{idx} outside of bounds 0..#{length - 1}"
+      end
+
+      item_ptr = data_ptr + idx * element_size
+      convertor = GirFFI::ArrayElementConvertor.new element_type, item_ptr
+      convertor.to_ruby_value
+    end
+
     private
 
     def data_ptr
@@ -83,7 +93,7 @@ module GLib
     def check_element_size_match
       return if calculated_element_size == get_element_size
 
-      warn 'WARNING: Element sizes do not match'
+      warn "WARNING: Element sizes do not match"
     end
 
     def guess_element_type

data/lib/ffi-glib/byte_array.rb

@@ -15,8 +15,13 @@ module GLib
       self.class.wrap Lib.g_byte_array_append(to_ptr, bytes, len)
     end
 
-    def initialize
-      store_pointer(Lib.g_byte_array_new)
+    def self.from(data)
+      case data
+      when self
+        data
+      else
+        new.append(data)
+      end
     end
   end
 end

data/lib/ffi-glib/container_class_methods.rb

@@ -18,7 +18,7 @@ module GLib
             end
 
       super(ptr).tap do |container|
-        container.reset_typespec typespec if container
+        container&.reset_typespec typespec
       end
     end
 

data/lib/ffi-glib/error.rb

@@ -5,7 +5,7 @@ GLib.load_class :Error
 module GLib
   # Overrides for GError, used by GLib for handling non-fatal errors.
   class Error
-    GIR_FFI_DOMAIN = GLib.quark_from_string('gir_ffi')
+    GIR_FFI_DOMAIN = GLib.quark_from_string("gir_ffi")
 
     def self.from_exception(exception)
       new_literal GIR_FFI_DOMAIN, 0, exception.message

data/lib/ffi-glib/hash_table.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ffi-glib/container_class_methods'
+require "ffi-glib/container_class_methods"
 
 GLib.load_class :HashTable
 
@@ -63,7 +63,7 @@ module GLib
       when :utf8
         FFI::Function.new(:uint,
                           [:pointer],
-                          find_support_function('g_str_hash'))
+                          find_support_function("g_str_hash"))
       end
     end
 
@@ -72,7 +72,7 @@ module GLib
       when :utf8
         FFI::Function.new(:int,
                           [:pointer, :pointer],
-                          find_support_function('g_str_equal'))
+                          find_support_function("g_str_equal"))
       end
     end
 

data/lib/ffi-glib/list.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ffi-glib/list_methods'
+require "ffi-glib/list_methods"
 
 GLib.load_class :List
 

data/lib/ffi-glib/list_methods.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ffi-glib/container_class_methods'
+require "ffi-glib/container_class_methods"
 
 module GLib
   # Common methods for List and SList.

data/lib/ffi-glib/main_loop.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'singleton'
+require "singleton"
 
 GLib.load_class :MainLoop
 
@@ -40,7 +40,7 @@ module GLib
     setup_instance_method! :run
 
     def run_with_thread_enabler
-      ThreadEnabler.instance.setup_idle_handler if RUBY_ENGINE == 'ruby'
+      ThreadEnabler.instance.setup_idle_handler if RUBY_ENGINE == "ruby"
       RUNNING_LOOPS << self
       result = run_without_thread_enabler
       exception = EXCEPTIONS.shift
@@ -63,6 +63,6 @@ module GLib
   end
 end
 
-Signal.trap 'INT' do
+Signal.trap "INT" do
   GLib::MainLoop.handle_exception(Interrupt.new)
 end

data/lib/ffi-glib/ptr_array.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'ffi-glib/container_class_methods'
-require 'ffi-glib/array_methods'
+require "ffi-glib/container_class_methods"
+require "gir_ffi/array_element_convertor"
 
 GLib.load_class :PtrArray
 
@@ -10,7 +10,6 @@ module GLib
   # pointers.
   class PtrArray
     include Enumerable
-    include ArrayMethods
     extend ContainerClassMethods
 
     attr_reader :element_type
@@ -49,12 +48,25 @@ module GLib
       ary.each { |item| add item }
     end
 
-    def data_ptr
-      struct[:pdata]
-    end
+    # Re-implementation of the g_ptrarray_index macro
+    def index(idx)
+      unless (0...length).cover? idx
+        raise IndexError, "Index #{idx} outside of bounds 0..#{length - 1}"
+      end
 
-    def element_size
-      POINTER_SIZE
+      item_ptr = data_ptr + idx * element_size
+
+      convert_element_type = case element_type
+                             when :utf8
+                               :utf8
+                             when GirFFI::ObjectBase
+                               element_type
+                             else
+                               [:pointer, element_type]
+                             end
+
+      convertor = GirFFI::ArrayElementConvertor.new convert_element_type, item_ptr
+      convertor.to_ruby_value
     end
 
     def each
@@ -70,5 +82,15 @@ module GLib
     def ==(other)
       to_a == other.to_a
     end
+
+    private
+
+    def element_size
+      POINTER_SIZE
+    end
+
+    def data_ptr
+      struct[:pdata]
+    end
   end
 end

data/lib/ffi-glib/s_list.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ffi-glib/list_methods'
+require "ffi-glib/list_methods"
 
 GLib.load_class :SList
 

data/lib/ffi-glib/variant.rb

@@ -5,7 +5,7 @@ GLib.load_class :Variant
 module GLib
   # Overrides for GVariant, GLib's variant data type.
   class Variant
-    setup_instance_method! 'get_string'
+    setup_instance_method! "get_string"
 
     def get_string_with_override
       get_string_without_override.first

data/lib/ffi-glib.rb

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
 
 # Ensure GLib is defined by GirFFI itself
-raise 'The module GLib was already defined elsewhere' if Kernel.const_defined? :GLib
+raise "The module GLib was already defined elsewhere" if Kernel.const_defined? :GLib
 
-require 'gir_ffi/core'
+require "gir_ffi/core"
 
 # Bypass check for existing modules
-GirFFI::Builders::ModuleBuilder.new('GLib').generate
-
-require 'ffi-glib/array'
-require 'ffi-glib/byte_array'
-require 'ffi-glib/bytes'
-require 'ffi-glib/destroy_notify'
-require 'ffi-glib/error'
-require 'ffi-glib/hash_table'
-require 'ffi-glib/list'
-require 'ffi-glib/main_loop'
-require 'ffi-glib/ptr_array'
-require 'ffi-glib/s_list'
-require 'ffi-glib/strv'
-require 'ffi-glib/variant'
+GirFFI::Builders::ModuleBuilder.new("GLib").generate
+
+require "ffi-glib/array"
+require "ffi-glib/byte_array"
+require "ffi-glib/bytes"
+require "ffi-glib/destroy_notify"
+require "ffi-glib/error"
+require "ffi-glib/hash_table"
+require "ffi-glib/list"
+require "ffi-glib/main_loop"
+require "ffi-glib/ptr_array"
+require "ffi-glib/s_list"
+require "ffi-glib/strv"
+require "ffi-glib/variant"
 
 # Module representing GLib's GLib namespace.
 module GLib

data/lib/ffi-gobject/object.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'gir_ffi/property_not_found_error'
+require "gir_ffi/property_not_found_error"
 
 GObject.load_class :Object
 
@@ -44,7 +44,7 @@ module GObject
         obj
       end
     else
-      setup_method! 'new'
+      setup_method! "new"
 
       # Before GLib 2.54.0, use g_object_newv, which takes an array of GParameter.
       def initialize_with_automatic_gtype(properties = {})
@@ -90,22 +90,6 @@ module GObject
       end
     end
 
-    # TODO: Generate accessor methods from GIR at class definition time
-    def method_missing(method, *args)
-      getter_name = "get_#{method}"
-      return send(getter_name, *args) if respond_to?(getter_name)
-
-      if method.to_s =~ /(.*)=$/
-        setter_name = "set_#{Regexp.last_match[1]}"
-        return send(setter_name, *args) if respond_to?(setter_name)
-      end
-      super
-    end
-
-    def respond_to_missing?(*)
-      false
-    end
-
     def signal_connect(event, data = nil, &block)
       GObject.signal_connect(self, event, data, &block)
     end
@@ -114,30 +98,37 @@ module GObject
       GObject.signal_connect_after(self, event, data, &block)
     end
 
-    setup_instance_method! 'get_property'
-    setup_instance_method! 'set_property'
+    setup_instance_method! "get_property"
+    setup_instance_method! "set_property"
 
+    # @deprecated
     def get_property_extended(property_name)
-      value = get_property(property_name)
-      type_info = get_property_type property_name
-      property_value_post_conversion value, type_info
+      get_property(property_name)
     end
 
     def get_property_with_override(property_name)
       gvalue = gvalue_for_property property_name
       get_property_without_override property_name, gvalue
-      gvalue.get_value
+      value = gvalue.get_value
+
+      type_info = get_property_type property_name
+      value = property_value_post_conversion(value, type_info) if type_info
+
+      value
     end
 
+    # @deprecated
     def set_property_extended(property_name, value)
-      type_info = get_property_type property_name
-      adjusted_value = property_value_pre_conversion(value, type_info)
-      set_property property_name, adjusted_value
+      set_property property_name, value
     end
 
     def set_property_with_override(property_name, value)
+      type_info = get_property_type property_name
+      value = property_value_pre_conversion(value, type_info) if type_info
+
       gvalue = gvalue_for_property(property_name)
       gvalue.set_value value
+
       set_property_without_override property_name, gvalue
     end
 
@@ -147,7 +138,7 @@ module GObject
     alias set_property_without_override set_property
     alias set_property set_property_with_override
 
-    setup_instance_method! 'is_floating'
+    setup_instance_method! "is_floating"
     alias floating? is_floating
 
     private
@@ -165,8 +156,7 @@ module GObject
     end
 
     def get_property_type(property_name)
-      prop = self.class.find_property(property_name)
-      prop.property_type
+      self.class.find_property(property_name)&.property_type
     end
 
     def gvalue_for_property(property_name)
@@ -175,8 +165,7 @@ module GObject
     end
 
     def property_gtype(property_name)
-      pspec = property_param_spec(property_name)
-      pspec.value_type
+      property_param_spec(property_name).value_type
     end
 
     def property_param_spec(property_name)
@@ -207,6 +196,8 @@ module GObject
         GLib::List.from type_info.element_type, val
       when :strv
         GLib::Strv.from val
+      when :byte_array
+        GLib::ByteArray.from val
       when :callback
         GirFFI::Builder.build_class(type_info.interface).from val
       else