gir_ffi 0.14.0 → 0.15.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fc709e79ed9d8d423b39d2793e648a3d4cf62603496f5398fe80515a756fe96
-  data.tar.gz: 2ca46650022b545f0dff670fc8bbaa27c159ed43c101fde1d674ab064b4dec36
+  metadata.gz: 2ee5f86f4d4106139b51edf6855aa3a84bff5437b728dac4c0b878a61bbf86ea
+  data.tar.gz: de0aef98573ba69d41ffa094d08f576977928e6e55598586cf07c08c9c38da6f
 SHA512:
-  metadata.gz: ad913da79bffc07e693e94aa2e56aa0b425c48999b84ffcee0a92a06439b75a46cd7db04f19cb5bc87b8869c541b7b374538c9aea300c2ffbf973d50f8b8bc5c
-  data.tar.gz: d661d30631b2470b85f9ff59abf36e2c63f380ba94f40a5b98eb0e5fd1ebb0943b94c5b6dff2cb6737bc264746c014f5c24e080fceea13b7eb20a2de8077f54e
+  metadata.gz: 57de8a0753d8add11635ca497712988aa16507312d719bdc6ed7c8f63a707275622b73c1d968e742d13ba96094fe253baf6d60076dd186683851479cffa8cbe2
+  data.tar.gz: abc9d12f2590a325ab3d8deb087cc4dcf4f5e1eccf0a4dd2f74f48c50553c3b63c19cd799661830da3c13850d50b32cdcb6113ebfb0569b15e7875796a7287ed

data/Changelog.md

@@ -1,5 +1,50 @@
 # Changelog
 
+## 0.15.3 / 2020-06-14
+
+* Officially support Ruby 2.7
+* Officially drop support for Ruby 2.4
+* Store classes representing inline callback types in the class that defines
+  them instead of in the main namespace, thus avoiding some potential name
+  clashes
+* Update development dependencies
+* Various code quality improvements
+* Record approved licenses for dependencies
+
+## 0.15.2 / 2019-11-29
+
+* Load girepository-1.0 library in a way that does not require installing a
+  development package.
+
+## 0.15.1 / 2019-10-20
+
+* Allow access to properties for unintrospectable classes.
+
+## 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.
+
 ## 0.14.0 / 2018-09-25
 
 * Do not generate field accessors for Object types. Object data should normally

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.13.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,17 +63,18 @@ 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.
+`gobject-introspection`, `gir1.2-gtop-2.0`, `gir1.2-gtk-3.0`,
+`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.
+GirFFI has not been tested on Mac OS X or Microsoft Windows. YMMV. Pull
+requests to support these platforms are welcome.
 
 ## Overrides
 
@@ -96,9 +97,9 @@ Please feel free to file bugs or send pull requests!
 If you just want to help out but don't know where to start, have a look at
 TODO.md, and check the notes in the code (e.g., using `dnote`).
 
-If you want to send pull requests or patches, please try to follow these
-instructions. If you get stuck, make a pull request anyway and I'll try to help
-out.
+If you want to send pull requests or patches, try to follow the instructions
+below. **If you get stuck, please make a pull request anyway and I'll try to
+help out.**
 
 * Make sure `rake test` runs without reporting any failures.
 * Add tests for your feature. Otherwise, I can't see if it works or if I
@@ -119,7 +120,7 @@ The following people have contributed to GirFFI over the years:
 
 ## License
 
-Copyright © 2009–2018 [Matijs van Zuijlen](http://www.matijs.net)
+Copyright © 2009–2019 [Matijs van Zuijlen](http://www.matijs.net)
 
 GirFFI is free software, distributed under the terms of the GNU Lesser
 General Public License, version 2.1 or later. See the file COPYING.LIB for

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.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-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-gobject.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require 'gir_ffi/core'
+require "gir_ffi/core"
 
 # Bypass check for existing modules
-GirFFI::Builders::ModuleBuilder.new('GObject').generate
+GirFFI::Builders::ModuleBuilder.new("GObject").generate
 
-require 'ffi-gobject/value'
-require 'ffi-gobject/initially_unowned'
-require 'ffi-gobject/closure'
-require 'ffi-gobject/object'
-require 'ffi-gobject/object_class'
-require 'ffi-gobject/param_spec'
-require 'ffi-gobject/ruby_closure'
-require 'gir_ffi/signal_not_found_error'
+require "ffi-gobject/value"
+require "ffi-gobject/initially_unowned"
+require "ffi-gobject/closure"
+require "ffi-gobject/object"
+require "ffi-gobject/object_class"
+require "ffi-gobject/param_spec"
+require "ffi-gobject/ruby_closure"
+require "gir_ffi/signal_not_found_error"
 
 # Module representing GLib's GObject namespace.
 module GObject
@@ -47,7 +47,7 @@ module GObject
   end
 
   def self.signal_emit(object, detailed_signal, *args)
-    signal, detail = detailed_signal.split('::')
+    signal, detail = detailed_signal.split("::")
     signal_id = signal_lookup_from_instance signal, object
     detail_quark = GLib.quark_from_string(detail)
 
@@ -63,9 +63,9 @@ module GObject
   end
 
   def self.signal_connect(object, detailed_signal, data = nil, after = false, &block)
-    raise ArgumentError, 'Block needed' unless block_given?
+    raise ArgumentError, "Block needed" unless block_given?
 
-    signal_name, = detailed_signal.split('::')
+    signal_name, = detailed_signal.split("::")
     sig_info = object.class.find_signal signal_name
 
     closure = sig_info.wrap_in_closure do |*args|