gir_ffi 0.14.1 → 0.15.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c32084045b640a22901bdd0d256ce8b8df1ace345930d3e4fccfd0e598b82b19
-  data.tar.gz: 5ac1e06a4dd28b4589ca93e30c48218a4cffb40f18d9f8c87859fdd76460fc8c
+  metadata.gz: 1cd304c670b5b7b26e9bbaa939f2b5162ef3f92f7c0bd78d8e524b1586cbdb3b
+  data.tar.gz: ccf4916ed552cf23752fb6270a61cfffdea53269b7d4bdb0bb408f3e3de7ae59
 SHA512:
-  metadata.gz: f70592c52c01f747ca9370007783231007ef535a0039337aaf42e46a17acbf2a54178b33c591ca8658e040496bb66a34ffd1f8126b2b323470783b97418418ae
-  data.tar.gz: fd92518d3541a1c46ebfe4758af76e8f746cf7ae355797a7f5736cdb4bc4b8444f6e9b4be7bf08712155759b11e5d697c2bdb522f3a4241337446204e5fb13c3
+  metadata.gz: 59fa0cf7451808b87a1ff028c0b8309d7c46c2acbbc894c535db4e1b3f30be7d6ee9649472a6932dd1fea0747bda6f56ceb3c753c48370750966c06da509f5bf
+  data.tar.gz: e2bd4de38d2db08b17e20c1bc42556530b4b14312400d5b9e15dc201eaf1494606bfe56c7fcdf78d632d164f6b553e897f488d533d70ab6d35042e069e5c5f61

data/Changelog.md

@@ -1,5 +1,61 @@
 # Changelog
 
+## 0.15.4 / 2020-11-01
+
+* Support disguised object class structs
+* Handle the case where vfunc object arguments are null
+* Bail out earlier when trying to register non-GObject class
+* Small improvements
+* Use `Module#prepend` for overrides
+* Clean up initialization of structs, unions, and boxed types
+* Make `GObject::Object#store_pointer` private like in the superclass
+* Handle creating SizedArray of uint8 from a string
+* Improve derived class setup
+* Improve List and SList methods
+* Make `ByteArray#append` return self
+* Improve packaging infrastructure (thanks, utkarsh2102!)
+
+## 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.

data/README.md

@@ -12,7 +12,6 @@ Ruby bindings for GNOME using the GObject Introspection Repository.
 [![Depfu](https://badges.depfu.com/badges/d5a8e9bffd2462a7ab4921d2f7e6fc48/overview.svg)](https://depfu.com/github/mvz/gir_ffi)
 [![Build Status](https://travis-ci.org/mvz/gir_ffi.svg?branch=master)](https://travis-ci.org/mvz/gir_ffi)
 [![Code Climate](https://codeclimate.com/github/mvz/gir_ffi/badges/gpa.svg)](https://codeclimate.com/github/mvz/gir_ffi)
-[![Coverage Status](https://coveralls.io/repos/github/mvz/gir_ffi/badge.svg?branch=master)](https://coveralls.io/github/mvz/gir_ffi?branch=master)
 [![Documentation Status](https://inch-ci.org/github/mvz/gir_ffi.svg?branch=master)](https://inch-ci.org/github/mvz/gir_ffi/branch/master)
 
 ## Features
@@ -53,7 +52,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.5, 2.6 and 2.7, and JRuby 9.2.
 
 You will also need gobject-introspection installed with some
 introspection data.
@@ -63,17 +62,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`
+On Debian and Ubuntu, installing `libgirepository-1.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`, `libcairo2-dev`, `gir1.2-gtop-2.0`, `gir1.2-gtk-3.0`,
+`gir1.2-pango-1.0`, `gir1.2-gtksource-3.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 +96,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 +119,7 @@ The following people have contributed to GirFFI over the years:
 
 ## License
 
-Copyright © 2009–2018 [Matijs van Zuijlen](http://www.matijs.net)
+Copyright © 2009–2020 [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/TODO.md

@@ -26,57 +26,36 @@ These in the order they occured to me, and may therefore be fixed in any order.
 
 ## Derived types
 
-Derived classes can now be registered with GObject, but the way to do this is
-not very nice:
+Derived classes are now registered like so:
 
     class Derived < Base
-    end
+      install_property GObject.param_spec_int("foo", "foo bar",
+                                              "The Foo Bar Property",
+                                               10, 20, 15, 3)
 
-    GirFFI.define_type Derived do |info|
-      info.install_property GObject.param_spec_int("foo", "foo bar",
-                                                   "The Foo Bar Property",
-                                                   10, 20, 15, 3)
       # assume Base defines a virtual function called 'some_vfunc'
-      info.install_vfunc_implementation :some_vfunc, proc {|obj|
-        #implementation goes here
+      install_vfunc_implementation :some_vfunc, proc {|obj|
+        # implementation goes here
       }
-    end
 
-or
-
-    class Derived < Base
-      def some_vfunc
-        #implementation goes here
+      def other_vfunc
+        # implementation
       end
-    end
 
-    GirFFI.define_type Derived do |info|
-      info.install_property GObject.param_spec_int("foo", "foo bar",
-                                                   "The Foo Bar Property",
-                                                   10, 20, 15, 3)
-      info.install_vfunc_implementation :some_vfunc
+      # assume Base defines a virtual function called 'other_vfunc'
+      install_vfunc_implementation :other_vfunc
     end
 
+    GirFFI.define_type Derived
+
+Potential improvements:
 
-It would be good to replace this with something that's easier to use:
+* Allow `define_type` to be called in the class definition
 * Perhaps auto-register types, like Gtk# does
 * Perhaps automagically find vfunc implementations, like PyGObject and
   Ruby-GNOME do
 * What about properties?
 
-How about:
-
-    class Derived < Base
-      include SomeGObjectInterface
-
-      register_type 'Derived'
-
-      install_property ...
-      install_vfunc_implementation ...
-    end
-
-This needs issue #63 to be resolved.
-
 NOTE: When adding an interface module to a derived class, its prerequisites
 should be checked.
 

data/docs/Documentation.md

@@ -0,0 +1,6 @@
+# Documentation
+
+See [the README](../README.md) for basic usage.
+
+See [Subclassing](Subclassing.md) for details on creating your own subclasses
+of GObject classes.

data/docs/Subclassing.md

@@ -0,0 +1,38 @@
+# Subclassing
+
+Creating a Ruby subclass of one of the GObject classes requires following some rules.
+
+First of all, if you override the initializer, you **must** call `super`
+otherwise, the underlying GObject pointer will not be created and stored.
+
+Second, GObject objects often have several constructors. GirFFI creates a
+separate initializer for each constructor. This allows customization of the
+call to super for each initializer. This means you will have to override each
+initializer separately, as needed.
+
+As an example, here is a subclass of `Regress::TestSubObj`, a class from
+GObjectIntrospection's test suite, adding an extra argument to some of its
+constructors.
+
+```
+class MyObj < Regress::TestSubObj
+  attr_reader :animal
+
+  def initialize animal
+    super()
+    @animal = animal
+  end
+
+  def initialize_from_file animal, file
+    super(file)
+    @animal = animal
+  end
+end
+
+o1 = MyObj.new 'dog'
+o1.foo                                          # => 'dog'
+o2 = MyObj.constructor
+o2.foo                                          # => nil
+o3 = MyObj.new_from_file 'cat', 'my_file.txt'
+o3.foo                                          # => 'cat'
+```

data/lib/ffi-glib.rb

@@ -1,25 +1,26 @@
 # frozen_string_literal: true
 
 # Ensure GLib is defined by GirFFI itself
-raise 'The module GLib was already defined elsewhere' if Kernel.const_defined? :GLib
-
-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'
+raise "The module GLib was already defined elsewhere" if Kernel.const_defined? :GLib
+
+require "gir_ffi/core"
+
+# Set up the GLib module, bypassing the check for existing modules. This also
+# creates GLib::Lib.
+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
@@ -28,12 +29,16 @@ module GLib
   load_class :EqualFunc
   load_class :Func
 
-  # Module for attaching functions from the glib library.
-  # NOTE: This module is defined by the call to GirFFI.setup above.
+  # Module for attaching functions from the glib library. This module is
+  # defined by the call to ModuleBuilder#generate above.
   module Lib
+    attach_function :g_slist_append, [:pointer, :pointer], :pointer
     attach_function :g_slist_prepend, [:pointer, :pointer], :pointer
+    attach_function :g_slist_reverse, [:pointer], :pointer
 
     attach_function :g_list_append, [:pointer, :pointer], :pointer
+    attach_function :g_list_prepend, [:pointer, :pointer], :pointer
+    attach_function :g_list_reverse, [:pointer], :pointer
 
     attach_function :g_hash_table_foreach, [:pointer, HFunc, :pointer], :void
     attach_function :g_hash_table_new, [HashFunc, EqualFunc], :pointer

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

@@ -12,11 +12,17 @@ module GLib
     def append(data)
       bytes = GirFFI::InPointer.from_utf8 data
       len = data.bytesize
-      self.class.wrap Lib.g_byte_array_append(to_ptr, bytes, len)
+      Lib.g_byte_array_append(to_ptr, bytes, len)
+      self
     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/destroy_notify.rb

@@ -9,8 +9,8 @@ module GLib
   class DestroyNotify
     def self.default
       @default ||= from proc { |user_data|
-        callback_key = GirFFI::ArgHelper::OBJECT_STORE.fetch(user_data)
-        drop_callback callback_key
+        callback = GirFFI::ArgHelper::OBJECT_STORE.fetch(user_data)
+        drop_callback callback
       }
     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
 
@@ -10,8 +10,7 @@ module GLib
     include Enumerable
     extend ContainerClassMethods
 
-    attr_reader :key_type
-    attr_reader :value_type
+    attr_reader :key_type, :value_type
 
     def initialize(key_type, value_type)
       @key_type = key_type
@@ -63,7 +62,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 +71,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