gir_ffi 0.15.3 → 0.15.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ee5f86f4d4106139b51edf6855aa3a84bff5437b728dac4c0b878a61bbf86ea
-  data.tar.gz: de0aef98573ba69d41ffa094d08f576977928e6e55598586cf07c08c9c38da6f
+  metadata.gz: 1cd304c670b5b7b26e9bbaa939f2b5162ef3f92f7c0bd78d8e524b1586cbdb3b
+  data.tar.gz: ccf4916ed552cf23752fb6270a61cfffdea53269b7d4bdb0bb408f3e3de7ae59
 SHA512:
-  metadata.gz: 57de8a0753d8add11635ca497712988aa16507312d719bdc6ed7c8f63a707275622b73c1d968e742d13ba96094fe253baf6d60076dd186683851479cffa8cbe2
-  data.tar.gz: abc9d12f2590a325ab3d8deb087cc4dcf4f5e1eccf0a4dd2f74f48c50553c3b63c19cd799661830da3c13850d50b32cdcb6113ebfb0569b15e7875796a7287ed
+  metadata.gz: 59fa0cf7451808b87a1ff028c0b8309d7c46c2acbbc894c535db4e1b3f30be7d6ee9649472a6932dd1fea0747bda6f56ceb3c753c48370750966c06da509f5bf
+  data.tar.gz: e2bd4de38d2db08b17e20c1bc42556530b4b14312400d5b9e15dc201eaf1494606bfe56c7fcdf78d632d164f6b553e897f488d533d70ab6d35042e069e5c5f61

data/Changelog.md

@@ -1,5 +1,20 @@
 # 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

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.4, 2.5 and 2.6, and JRuby 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.
@@ -65,12 +64,12 @@ libraries.
 
 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`,
-`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
+`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. Pull
@@ -120,7 +119,7 @@ The following people have contributed to GirFFI over the years:
 
 ## License
 
-Copyright © 2009–2019 [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

@@ -5,7 +5,8 @@ raise "The module GLib was already defined elsewhere" if Kernel.const_defined? :
 
 require "gir_ffi/core"
 
-# Bypass check for existing modules
+# 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"
@@ -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/byte_array.rb

@@ -12,7 +12,8 @@ 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 self.from(data)

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/hash_table.rb

@@ -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

data/lib/ffi-glib/list.rb

@@ -9,13 +9,19 @@ module GLib
   class List
     include ListMethods
 
-    def self.from_enumerable(type, arr)
-      arr.reduce(new(type)) { |lst, val| lst.append val }
+    def append(data)
+      store_pointer Lib.g_list_append(self, element_ptr_for(data))
+      self
     end
 
-    def append(data)
-      self.class.wrap(element_type,
-                      Lib.g_list_append(self, element_ptr_for(data)))
+    def prepend(data)
+      store_pointer Lib.g_list_prepend(self, element_ptr_for(data))
+      self
+    end
+
+    def reverse
+      store_pointer Lib.g_list_reverse(self)
+      self
     end
   end
 end

data/lib/ffi-glib/list_methods.rb

@@ -14,6 +14,7 @@ module GLib
       replace_method base, :data, :head
 
       base.extend ContainerClassMethods
+      base.extend ClassMethods
     end
 
     def self.replace_method(base, old, new)
@@ -36,10 +37,14 @@ module GLib
     end
 
     def tail
+      return nil if struct.null?
+
       self.class.wrap(element_type, struct[:next])
     end
 
     def head
+      return nil if struct.null?
+
       GirFFI::ArgHelper.cast_from_pointer(element_type, struct[:data])
     end
 
@@ -69,5 +74,12 @@ module GLib
     def element_ptr_for(data)
       GirFFI::InPointer.from(element_type, data)
     end
+
+    # Common class methods for List and SList
+    module ClassMethods
+      def from_enumerable(type, arr)
+        arr.reduce(new(type)) { |lst, val| lst.prepend val }.reverse
+      end
+    end
   end
 end

data/lib/ffi-glib/s_list.rb

@@ -9,13 +9,19 @@ module GLib
   class SList
     include ListMethods
 
-    def self.from_enumerable(type, arr)
-      arr.reverse.reduce(new(type)) { |lst, val| lst.prepend val }
+    def append(data)
+      store_pointer Lib.g_slist_append(self, element_ptr_for(data))
+      self
     end
 
     def prepend(data)
-      self.class.wrap(element_type,
-                      Lib.g_slist_prepend(self, element_ptr_for(data)))
+      store_pointer Lib.g_slist_prepend(self, element_ptr_for(data))
+      self
+    end
+
+    def reverse
+      store_pointer Lib.g_slist_reverse(self)
+      self
     end
   end
 end

data/lib/ffi-gobject.rb

@@ -92,7 +92,6 @@ module GObject
     attach_function :g_object_unref, [:pointer], :pointer
 
     attach_function :g_value_copy, [:pointer, :pointer], :void
-    attach_function :g_value_init, [:pointer, :size_t], :pointer
     attach_function :g_value_unset, [:pointer], :pointer
 
     attach_function :g_signal_connect_data,
@@ -106,7 +105,5 @@ module GObject
 
     attach_function :g_param_spec_ref, [:pointer], :pointer
     attach_function :g_param_spec_sink, [:pointer], :pointer
-
-    attach_function :g_type_class_ref, [:size_t], :pointer
   end
 end

data/lib/ffi-gobject/object.rb

@@ -74,11 +74,6 @@ module GObject
       self
     end
 
-    def store_pointer(ptr)
-      super
-      ObjectSpace.define_finalizer self, self.class.make_finalizer(ptr)
-    end
-
     def self.make_finalizer(ptr)
       proc do
         rc = GObject::Object::Struct.new(ptr)[:ref_count]
@@ -100,49 +95,20 @@ module GObject
 
     setup_instance_method! "get_property"
     setup_instance_method! "set_property"
+    setup_instance_method! "is_floating"
+    alias floating? is_floating
 
-    # @deprecated
-    def get_property_extended(property_name)
-      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
-      value = gvalue.get_value
-
-      type_info = get_property_type property_name
-      value = property_value_post_conversion(value, type_info) if type_info
-
-      value
-    end
+    private
 
-    # @deprecated
-    def set_property_extended(property_name, value)
-      set_property property_name, value
+    def store_pointer(ptr)
+      super
+      make_finalizer
     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
+    def make_finalizer
+      ObjectSpace.define_finalizer self, self.class.make_finalizer(struct.to_ptr)
     end
 
-    alias get_property_without_override get_property
-    alias get_property get_property_with_override
-
-    alias set_property_without_override set_property
-    alias set_property set_property_with_override
-
-    setup_instance_method! "is_floating"
-    alias floating? is_floating
-
-    private
-
     def names_and_gvalues_for_properties(properties)
       return [], [] unless properties.any?
 
@@ -155,10 +121,6 @@ module GObject
       end.transpose
     end
 
-    def get_property_type(property_name)
-      self.class.find_property(property_name)&.property_type
-    end
-
     def gvalue_for_property(property_name)
       gtype = property_gtype property_name
       GObject::Value.for_gtype gtype
@@ -173,36 +135,78 @@ module GObject
         raise GirFFI::PropertyNotFoundError.new(property_name, self.class)
     end
 
-    # TODO: Move to ITypeInfo and unify with ArgHelper.cast_from_pointer
-    def property_value_post_conversion(val, type_info)
-      case type_info.flattened_tag
-      when :ghash
-        GLib::HashTable.from type_info.element_type, val
-      when :glist
-        GLib::List.from type_info.element_type, val
-      when :callback
-        GirFFI::Builder.build_class(type_info.interface).wrap val
-      else
-        val
+    # Overrides for GObject, GObject's generic base class.
+    module Overrides
+      # @deprecated
+      def get_property_extended(property_name)
+        get_property(property_name)
+      end
+
+      def get_property(property_name)
+        gvalue = gvalue_for_property property_name
+        super property_name, gvalue
+        value = gvalue.get_value
+
+        type_info = get_property_type property_name
+        value = property_value_post_conversion(value, type_info) if type_info
+
+        value
       end
-    end
 
-    # TODO: Move to ITypeInfo and unify with ArgHelper.cast_from_pointer
-    def property_value_pre_conversion(val, type_info)
-      case type_info.flattened_tag
-      when :ghash
-        GLib::HashTable.from type_info.element_type, val
-      when :glist
-        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
-        val
+      # @deprecated
+      def set_property_extended(property_name, value)
+        set_property property_name, value
+      end
+
+      def set_property(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
+
+        super property_name, gvalue
+      end
+
+      private
+
+      def get_property_type(property_name)
+        self.class.find_property(property_name)&.property_type
+      end
+
+      # TODO: Move to ITypeInfo and unify with ArgHelper.cast_from_pointer
+      def property_value_post_conversion(val, type_info)
+        case type_info.flattened_tag
+        when :ghash
+          GLib::HashTable.from type_info.element_type, val
+        when :glist
+          GLib::List.from type_info.element_type, val
+        when :callback
+          GirFFI::Builder.build_class(type_info.interface).wrap val
+        else
+          val
+        end
+      end
+
+      # TODO: Move to ITypeInfo and unify with ArgHelper.cast_from_pointer
+      def property_value_pre_conversion(val, type_info)
+        case type_info.flattened_tag
+        when :ghash
+          GLib::HashTable.from type_info.element_type, val
+        when :glist
+          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
+          val
+        end
       end
     end
+
+    prepend Overrides
   end
 end