gir_ffi 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1adc3c9b00a49fef5e4ae2dc6674c79c62dc56b6
-  data.tar.gz: 47303f482166c93c612ed7debdf2d2ed95aad752
+  metadata.gz: 18cf75d3dd4a310371647db4f56ab2bdcf516245
+  data.tar.gz: d3a5fe4123bdc4ae02e7eae61364e87fa7f01cca
 SHA512:
-  metadata.gz: d6983eb6497add24e59e8d8041b815fccd9615e8e9d42895a8e1afbacb44c180a9e6bf63a9a719c6c5bca0552c9fb426391aefe5f668ba44669a3e425554fc2f
-  data.tar.gz: b904270d51f8905733777fb1ad5e9f6c8da61dd44153c078c472befcd0eee83988ebc08d95d9bb0dc3f57866cd4b4638e45046239fac63a0aa5ddc7e23ba6f49
+  metadata.gz: 5280cf6c320d6c50cf10bf320c8738ed5c14ae22867ceb8c8de74a31d6a1a6c5990cb572d26772574bac971296547ca333fcd91e051d3e8aaae2165851a2ac0d
+  data.tar.gz: 4f2d7eb7bb6161c3436388ce09b3948e7e04f428053055eedf4386f264dd7faac6c91d6b198abf52b471319b3a0cd6be6e905a68ee3076a21ac03a99731ea0db

data/Changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.7.5 / 2014-06-22
+
+* Use closures as signal handlers, rather than callbacks
+* Obtain reference to GVariant on creation
+* Make struct arguments work in JRuby
+* Various refactoring & code cleanup
+
 ## 0.7.4 / 2014-05-03
 
 * Correctly handle closure data arguments originating from C

data/TODO.md

@@ -89,6 +89,14 @@ to be put in place for that.
 
 For how to handle objects, see https://bugzilla.gnome.org/show_bug.cgi?id=657202#c1
 
+## External dependencies
+
+Things that I think GirFFI cannot fix:
+
+* gobject-introspection should correctly mark private fields as not readable.
+* gobject-introspection should ignore functions that are only defined but not
+  implemented, or implement those cases in GIMarshallingTests.
+
 ## See Also
 
   dnote

data/lib/ffi-glib/array.rb

@@ -1,9 +1,9 @@
 require 'ffi-glib/container_class_methods'
 require 'ffi-glib/array_methods'
 
-module GLib
-  load_class :Array
+GLib.load_class :Array
 
+module GLib
   # Overrides for GArray, GLib's automatically growing array. It should not
   # be necessary to create objects of this class from Ruby directly.
   class Array
@@ -46,8 +46,8 @@ module GLib
 
     alias element_size get_element_size
 
-    def ==(other)
-      self.to_a == other.to_a
+    def == other
+      to_a == other.to_a
     end
 
     def reset_typespec typespec
@@ -57,7 +57,7 @@ module GLib
     end
 
     def self.from_enumerable elmtype, it
-      self.new(elmtype).tap {|arr| arr.append_vals it }
+      new(elmtype).tap {|arr| arr.append_vals it }
     end
 
     private
@@ -68,11 +68,11 @@ module GLib
     end
 
     def calculated_element_size
-      self.class.calculated_element_size self.element_type
+      self.class.calculated_element_size element_type
     end
 
     def check_element_size_match
-      unless calculated_element_size == self.get_element_size
+      unless calculated_element_size == get_element_size
         warn "WARNING: Element sizes do not match"
       end
     end

data/lib/ffi-glib/byte_array.rb

@@ -1,6 +1,6 @@
-module GLib
-  load_class :ByteArray
+GLib.load_class :ByteArray
 
+module GLib
   # Overrides for GByteArray, GLib's automatically growing array of bytes.
   class ByteArray
     def to_string
@@ -10,7 +10,7 @@ module GLib
     def append data
       bytes = GirFFI::InPointer.from :utf8, data
       len = data.bytesize
-      self.class.wrap(Lib.g_byte_array_append self.to_ptr, bytes, len)
+      self.class.wrap(Lib.g_byte_array_append to_ptr, bytes, len)
     end
 
     class << self; undef :new; end
@@ -20,4 +20,3 @@ module GLib
     end
   end
 end
-

data/lib/ffi-glib/bytes.rb

@@ -1,6 +1,6 @@
-module GLib
-  load_class :Bytes
+GLib.load_class :Bytes
 
+module GLib
   # Overrides for GBytes, GLib's immutable array of bytes.
   class Bytes
     include Enumerable
@@ -37,7 +37,7 @@ module GLib
 
     def self.new arr
       data = GirFFI::SizedArray.from :guint8, arr.size, arr
-      self.wrap Lib.g_bytes_new data.to_ptr, data.size
+      wrap Lib.g_bytes_new data.to_ptr, data.size
     end
 
     private

data/lib/ffi-glib/error.rb

@@ -1,6 +1,6 @@
-module GLib
-  load_class :Error
+GLib.load_class :Error
 
+module GLib
   # Overrides for GError, used by GLib for handling non-fatal errors.
   class Error
     # TODO: Auto-convert strings and symbols to quarks

data/lib/ffi-glib/hash_table.rb

@@ -1,8 +1,8 @@
 require 'ffi-glib/container_class_methods'
 
-module GLib
-  load_class :HashTable
+GLib.load_class :HashTable
 
+module GLib
   # Overrides for GHashTable, GLib's hash table implementation.
   class HashTable
     include Enumerable
@@ -12,23 +12,23 @@ module GLib
     attr_reader :value_type
 
     def each
-      prc = proc {|keyptr, valptr, userdata|
+      prc = proc {|keyptr, valptr, _userdata|
         key = GirFFI::ArgHelper.cast_from_pointer key_type, keyptr
         val = GirFFI::ArgHelper.cast_from_pointer value_type, valptr
         yield key, val
       }
       callback = GLib::HFunc.from prc
-      ::GLib::Lib.g_hash_table_foreach self.to_ptr, callback, nil
+      ::GLib::Lib.g_hash_table_foreach to_ptr, callback, nil
     end
 
     def to_hash
-      Hash[self.to_a]
+      Hash[to_a]
     end
 
     def insert key, value
       keyptr = GirFFI::InPointer.from key_type, key
       valptr = GirFFI::InPointer.from value_type, value
-      ::GLib::Lib.g_hash_table_insert self.to_ptr, keyptr, valptr
+      ::GLib::Lib.g_hash_table_insert to_ptr, keyptr, valptr
     end
 
     class << self; remove_method :new; end
@@ -44,7 +44,7 @@ module GLib
     end
 
     def self.from_enumerable typespec, hash
-      ghash = self.new(*typespec)
+      ghash = new(*typespec)
       hash.each do |key, val|
         ghash.insert key, val
       end

data/lib/ffi-glib/iconv.rb

@@ -1,9 +1,9 @@
-module GLib
-  load_class :IConv
+GLib.load_class :IConv
 
+module GLib
   # Overrides for IConv
   class IConv
-    def self.open(to_codeset, from_codeset)
+    def self.open to_codeset, from_codeset
       to_ptr = GirFFI::InPointer.from(:utf8, to_codeset)
       from_ptr = GirFFI::InPointer.from(:utf8, from_codeset)
       result_ptr = Lib.g_iconv_open(to_ptr, from_ptr)
@@ -11,4 +11,3 @@ module GLib
     end
   end
 end
-

data/lib/ffi-glib/list.rb

@@ -1,14 +1,14 @@
 require 'ffi-glib/list_methods'
 
-module GLib
-  load_class :List
+GLib.load_class :List
 
+module GLib
   # Overrides for GList, GLib's doubly linked list implementation.
   class List
     include ListMethods
 
     def self.from_enumerable type, arr
-      arr.inject(self.new type) { |lst, val| lst.append val }
+      arr.inject(new type) { |lst, val| lst.append val }
     end
 
     def append data

data/lib/ffi-glib/list_methods.rb

@@ -44,8 +44,8 @@ module GLib
       self
     end
 
-    def ==(other)
-      self.to_a == other.to_a
+    def == other
+      to_a == other.to_a
     end
 
     private
@@ -65,6 +65,7 @@ module GLib
       GirFFI::InPointer.from(element_type, data)
     end
 
+    # Common class methods for List and SList
     module ListClassMethods
       def new type
         _real_new.tap do |it|
@@ -76,4 +77,3 @@ module GLib
     end
   end
 end
-

data/lib/ffi-glib/ptr_array.rb

@@ -1,9 +1,9 @@
 require 'ffi-glib/container_class_methods'
 require 'ffi-glib/array_methods'
 
-module GLib
-  load_class :PtrArray
+GLib.load_class :PtrArray
 
+module GLib
   # Overrides for GPtrArray, GLib's automatically growing array of
   # pointers.
   class PtrArray
@@ -25,8 +25,8 @@ module GLib
       wrap(type, Lib.g_ptr_array_new)
     end
 
-    def self.from_enumerable(type, it)
-      self.new(type).tap {|arr| arr.add_array it}
+    def self.from_enumerable type, it
+      new(type).tap {|arr| arr.add_array it}
     end
 
     def self.add array, data
@@ -65,8 +65,8 @@ module GLib
       @struct[:len]
     end
 
-    def ==(other)
-      self.to_a == other.to_a
+    def == other
+      to_a == other.to_a
     end
   end
 end

data/lib/ffi-glib/s_list.rb

@@ -1,14 +1,14 @@
 require 'ffi-glib/list_methods'
 
-module GLib
-  load_class :SList
+GLib.load_class :SList
 
+module GLib
   # Overrides for GSList, GLib's singly-linked list implementation.
   class SList
     include ListMethods
 
     def self.from_enumerable type, arr
-      arr.reverse.inject(self.new type) { |lst, val| lst.prepend val }
+      arr.reverse.inject(new type) { |lst, val| lst.prepend val }
     end
 
     def prepend data

data/lib/ffi-glib/strv.rb

@@ -1,8 +1,8 @@
 module GLib
   # Extra methods for GLib::Strv. The bulk is defined in `gir_ffi-base/glib/strv.rb`
   class Strv
-    def ==(other)
-      self.to_a == other.to_a
+    def == other
+      to_a == other.to_a
     end
 
     def self.from it
@@ -19,7 +19,7 @@ module GLib
     end
 
     def self.from_enumerable enum
-      self.wrap GirFFI::InPointer.from_array :utf8, enum
+      wrap GirFFI::InPointer.from_array :utf8, enum
     end
   end
 end

data/lib/ffi-glib/variant.rb

@@ -1,6 +1,6 @@
-module GLib
-  load_class :Variant
+GLib.load_class :Variant
 
+module GLib
   # Overrides for GVariant, GLib's variant data type.
   class Variant
     setup_instance_method "get_string"
@@ -9,6 +9,10 @@ module GLib
       get_string_without_override.first
     end
 
+    def self.constructor_wrap ptr
+      super.tap {|variant| variant.ref }
+    end
+
     alias get_string_without_override get_string
     alias get_string get_string_with_override
   end

data/lib/ffi-glib.rb

@@ -15,12 +15,15 @@ require 'ffi-glib/s_list'
 require 'ffi-glib/strv'
 require 'ffi-glib/variant'
 
+# Module representing GLib's GLib namespace.
 module GLib
   load_class :HFunc
   load_class :HashFunc
   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 Lib
     attach_function :g_slist_prepend, [:pointer, :pointer], :pointer
 

data/lib/ffi-gobject/base.rb

@@ -1,3 +1,4 @@
+# Preload type contants
 module GObject
   TYPE_INVALID = type_from_name("invalid")
   TYPE_NONE = type_from_name("void")

data/lib/ffi-gobject/closure.rb

@@ -1,6 +1,6 @@
-module GObject
-  load_class :Closure
+GObject.load_class :Closure
 
+module GObject
   # Overrides for GClosure, GObject's base class for closure objects.
   class Closure
     def set_marshal marshal

data/lib/ffi-gobject/initially_unowned.rb

@@ -1,12 +1,13 @@
-module GObject
-  load_class :InitiallyUnowned
+GObject.load_class :InitiallyUnowned
 
+module GObject
   # Overrides for GInitiallyUnowned, GObject's base class for objects that
   # start with a floating reference.
   class InitiallyUnowned
+    # Wrapping method used in constructors. For InitiallyUnowned and
+    # descendants, this needs to sink the object's floating reference.
     def self.constructor_wrap ptr
       super.tap {|obj| ::GObject.object_ref_sink obj}
     end
   end
 end
-

data/lib/ffi-gobject/object.rb

@@ -1,13 +1,13 @@
-module GObject
-  load_class :Object
+GObject.load_class :Object
 
+module GObject
   # Overrides for GObject, GObject's generic base class.
   class Object
 
     setup_method "new"
 
     # TODO: Generate accessor methods from GIR at class definition time
-    def method_missing(method, *args)
+    def method_missing method, *args
       if respond_to?("get_#{method}")
         return send("get_#{method}", *args)
       end
@@ -17,7 +17,7 @@ module GObject
       super
     end
 
-    def signal_connect(event, &block)
+    def signal_connect event, &block
       GObject.signal_connect(self, event, &block)
     end
 
@@ -59,7 +59,7 @@ module GObject
     end
 
     def type_class
-      GObject::ObjectClass.wrap(self.to_ptr.get_pointer 0)
+      GObject::ObjectClass.wrap(to_ptr.get_pointer 0)
     end
 
     alias get_property_without_override get_property

data/lib/ffi-gobject/object_class.rb

@@ -1,6 +1,6 @@
-module GObject
-  load_class :ObjectClass
+GObject.load_class :ObjectClass
 
+module GObject
   # Overrides for GObjectClass, a struct containing GObject's class data
   class ObjectClass
     def set_property= callback

data/lib/ffi-gobject/ruby_closure.rb

@@ -34,11 +34,10 @@ module GObject
       closure.block = block
       closure.set_marshal Proc.new {|*args| marshaller(*args)}
 
-      return closure
+      closure
     end
 
-    def self.marshaller(closure, return_value, param_values,
-                        _invocation_hint, _marshal_data)
+    def self.marshaller closure, return_value, param_values, _invocation_hint, _marshal_data
       rclosure = wrap(closure.to_ptr)
       param_values ||= []
 

data/lib/ffi-gobject/value.rb

@@ -1,6 +1,6 @@
-module GObject
-  load_class :Value
+GObject.load_class :Value
 
+module GObject
   # Overrides for GValue, GObject's generic value container structure.
   class Value
     # TODO: Give more generic name
@@ -88,7 +88,7 @@ module GObject
 
     # TODO: Give more generic name
     def self.wrap_ruby_value val
-      self.new.set_ruby_value val
+      new.set_ruby_value val
     end
 
     def self.from val
@@ -104,12 +104,12 @@ module GObject
 
     def self.for_g_type g_type
       return nil if g_type == TYPE_NONE
-      self.new.tap {|it| it.init g_type }
+      new.tap {|it| it.init g_type }
     end
 
     # TODO: Combine with wrap_ruby_value
     def self.wrap_instance instance
-      self.new.tap {|it|
+      new.tap {|it|
         it.init GObject.type_from_instance instance
         it.set_instance instance
       }

data/lib/ffi-gobject.rb

@@ -16,19 +16,19 @@ require 'gir_ffi/builders/user_defined_builder'
 # Module representing GLib's GObject namespace.
 module GObject
   def self.object_ref obj
-    Lib::g_object_ref obj.to_ptr
+    Lib.g_object_ref obj.to_ptr
   end
 
   def self.object_ref_sink obj
-    Lib::g_object_ref_sink obj.to_ptr
+    Lib.g_object_ref_sink obj.to_ptr
   end
 
   def self.object_unref obj
-    Lib::g_object_unref obj.to_ptr
+    Lib.g_object_unref obj.to_ptr
   end
 
   def self.object_is_floating obj
-    Lib::g_object_is_floating obj.to_ptr
+    Lib.g_object_is_floating obj.to_ptr
   end
 
   def self.type_from_instance_pointer inst_ptr
@@ -52,8 +52,6 @@ module GObject
     ObjectClass.wrap klsptr
   end
 
-  setup_method :signal_emitv
-
   def self.signal_lookup_from_instance signal, object
     signal_lookup signal, type_from_instance(object)
   end
@@ -62,31 +60,29 @@ module GObject
     signal, detail = detailed_signal.split('::')
     signal_id = signal_lookup_from_instance signal, object
     detail_quark = GLib.quark_from_string(detail)
-    sig_info = object.class.find_signal signal
-
-    arr_ptr = sig_info.arguments_to_gvalue_array_pointer object, args
 
-    rval = sig_info.gvalue_for_return_value
+    sig_info = object.class.find_signal signal
+    argument_gvalues = sig_info.arguments_to_gvalues object, args
+    return_gvalue = sig_info.gvalue_for_return_value
 
-    Lib.g_signal_emitv arr_ptr, signal_id, detail_quark, rval
+    signal_emitv argument_gvalues, signal_id, detail_quark, return_gvalue
 
-    return rval
+    return_gvalue
   end
 
   def self.signal_connect object, detailed_signal, data=nil, &block
-    signal, _ = detailed_signal.split('::')
-    sig_info = object.class.find_signal signal
-    callback = sig_info.create_callback(&block)
-    GirFFI::CallbackBase.store_callback callback
+    raise ArgumentError, "Block needed" unless block_given?
+    signal_name, _ = detailed_signal.split('::')
+    sig_info = object.class.find_signal signal_name
 
-    data_ptr = GirFFI::InPointer.from_closure_data data
+    closure = sig_info.wrap_in_closure {|*args| block.call(*args << data) }
 
-    Lib.g_signal_connect_data object, detailed_signal, callback, data_ptr, nil, 0
+    # TODO: Provide _after variant
+    signal_connect_closure object, detailed_signal, closure, false
   end
 
   # Smells of :reek:LongParameterList: due to the C interface.
-  def self.param_spec_int(name, nick, blurb, minimum, maximum,
-                          default_value, flags)
+  def self.param_spec_int name, nick, blurb, minimum, maximum, default_value, flags
     ptr = Lib.g_param_spec_int(name, nick, blurb, minimum, maximum,
                                default_value, flags)
     ParamSpecInt.wrap(ptr)
@@ -98,9 +94,8 @@ module GObject
   load_class :ClosureMarshal
   load_class :ParamFlags
 
+  # NOTE: This Lib module is set up in `gir_ffi-base/gobject/lib.rb`.
   module Lib
-    # NOTE: This Lib module is set up in `gir_ffi-base/gobject/lib.rb`.
-
     attach_function :g_object_ref, [:pointer], :void
     attach_function :g_object_ref_sink, [:pointer], :void
     attach_function :g_object_unref, [:pointer], :void

data/lib/ffi-gobject_introspection/i_arg_info.rb

@@ -48,4 +48,3 @@ module GObjectIntrospection
     end
   end
 end
-

data/lib/ffi-gobject_introspection/i_base_info.rb

@@ -40,7 +40,7 @@ module GObjectIntrospection
       method = method.to_s
       single ||= method.to_s[0..-2]
       count = method.sub(/^(get_)?/, "\\1n_")
-      self.class_eval <<-CODE
+      class_eval <<-CODE
         def #{method}
           (0..(#{count} - 1)).map do |i|
             #{single} i
@@ -70,7 +70,7 @@ module GObjectIntrospection
       single = method.sub(/^find_/, "")
       counter ||= "n_#{single}s"
       fetcher ||= "#{single}"
-      self.class_eval <<-CODE
+      class_eval <<-CODE
         def #{method}(name)
           (0..(#{counter} - 1)).each do |i|
             it = #{fetcher}(i)
@@ -108,8 +108,7 @@ module GObjectIntrospection
     end
 
     def self.wrap ptr
-      return nil if ptr.null?
-      return new ptr
+      new ptr unless ptr.null?
     end
 
     def == other

data/lib/ffi-gobject_introspection/i_callable_info.rb

@@ -22,7 +22,7 @@ module GObjectIntrospection
       Lib.g_callable_info_get_n_args @gobj
     end
 
-    def arg(index)
+    def arg index
       IArgInfo.wrap(Lib.g_callable_info_get_arg @gobj, index)
     end
     ##
@@ -33,4 +33,3 @@ module GObjectIntrospection
     end
   end
 end
-

data/lib/ffi-gobject_introspection/i_constant_info.rb

@@ -14,24 +14,32 @@ module GObjectIntrospection
       utf8:    :v_string
     }
 
-    def value_union
-      val = Lib::GIArgument.new
-      Lib.g_constant_info_get_value @gobj, val
-      return val
-    end
-
     def value
-      tag = constant_type.tag
-      val = value_union[TYPE_TAG_TO_UNION_MEMBER[tag]]
-      if tag == :utf8
-        val.force_encoding("utf-8")
+      if type_tag == :utf8
+        raw_value.force_encoding("utf-8")
       else
-        val
+        raw_value
       end
     end
 
     def constant_type
       ITypeInfo.wrap(Lib.g_constant_info_get_type @gobj)
     end
+
+    private
+
+    def type_tag
+      @type_tag ||= constant_type.tag
+    end
+
+    def raw_value
+      value_union = Lib::GIArgument.new
+      Lib.g_constant_info_get_value @gobj, value_union
+      value_union[union_member_key]
+    end
+
+    def union_member_key
+      TYPE_TAG_TO_UNION_MEMBER[type_tag]
+    end
   end
 end