gir_ffi 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18cf75d3dd4a310371647db4f56ab2bdcf516245
-  data.tar.gz: d3a5fe4123bdc4ae02e7eae61364e87fa7f01cca
+  metadata.gz: 784da223496ff93dd574411f1058071f336aa18e
+  data.tar.gz: ffbc7a82e2b710669a74055bf436a8c26d2ed956
 SHA512:
-  metadata.gz: 5280cf6c320d6c50cf10bf320c8738ed5c14ae22867ceb8c8de74a31d6a1a6c5990cb572d26772574bac971296547ca333fcd91e051d3e8aaae2165851a2ac0d
-  data.tar.gz: 4f2d7eb7bb6161c3436388ce09b3948e7e04f428053055eedf4386f264dd7faac6c91d6b198abf52b471319b3a0cd6be6e905a68ee3076a21ac03a99731ea0db
+  metadata.gz: b9a5bbd317a59c9cad7840e318e9a03e12413a130e259677216fc7fe6ad9ab5592017bdff9904ec15da9aa65a8f5dbf72b3d74f33f477c3c698309bce3ff4649
+  data.tar.gz: 1c7ec6f5c809e141c6f5338c742a1a3042cdbc18645dfc3631f838fe090b36fa12822b60eddf875d58707f78e2ad9e5e16c28a9ef7843e41f16a7902a4e882a3

data/Changelog.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.7.6 / 2014-08-22
+
+* Work around respond_to? behavior in JRuby 1.6.13
+* Deprecate setup_class in favor of load_class
+* Support GValue containing GArray
+* Provide constant TYPE_BYTE_ARRAY
+* Don't recurse looking for signals and properties
+* Clean up generated code:
+  * Avoid use of an ignored dummy argument
+  * Clean up trailing whitespace
+* Drop support for Ruby 1.9.2
+* Allow data argument for GObject::Object#signal_connect
+* Let Ruby threads run during GLib's main loop
+* Make all dependencies versioned
+* Various refactoring & code cleanup
+
 ## 0.7.5 / 2014-06-22
 
 * Use closures as signal handlers, rather than callbacks
@@ -58,7 +74,7 @@
   * Register defined properties in a subclass
   * Support setting virtual function implementations in a subclass
   * Support adding an interface to a subclass
-  * Support implementing an interface's virtual functions in a subclass 
+  * Support implementing an interface's virtual functions in a subclass
 * Use FFI's DataConvertor system to handle enums and callbacks
 * Stop using deprecated GValueArray to construct argument array for signal_emit
 * Make ITypeInfo#g_type return correct value for c arrays

data/README.md

@@ -45,7 +45,7 @@ Ruby bindings for GNOME using the GObject Introspection Repository.
 
 ## Requirements
 
-GirFFI should work on MRI 1.9, 2.0, and 2.1, JRuby in 1.9 mode, and on
+GirFFI should work on MRI 1.9.3, 2.0, and 2.1, JRuby in 1.9 or 2.0 mode, and on
 Rubinius.
 
 You will also need gobject-introspection installed with some

data/Rakefile

@@ -9,14 +9,7 @@ end
 
 MyGemHelper.install_tasks
 
-begin
-  require 'repl_rake'
-  ReplRake.setup
-rescue LoadError
-end
-
 load 'tasks/test.rake'
 load 'tasks/valgrind.rake'
-load 'tasks/yard.rake'
 
 task :default => 'test:all'

data/examples/main_loop.rb

@@ -0,0 +1,12 @@
+require 'gir_ffi'
+
+main_loop = GLib::MainLoop.new nil, false
+
+Signal.trap("INT") do
+  if main_loop.is_running
+    main_loop.quit
+  end
+  exit
+end
+
+main_loop.run

data/lib/ffi-glib/array.rb

@@ -44,20 +44,24 @@ module GLib
       Lib.g_array_get_element_size self
     end
 
-    alias element_size get_element_size
+    alias_method :element_size, :get_element_size
 
     def == other
       to_a == other.to_a
     end
 
-    def reset_typespec typespec
-      @element_type = typespec
-      check_element_size_match
+    def reset_typespec typespec = nil
+      if typespec
+        @element_type = typespec
+        check_element_size_match
+      else
+        @element_type = guess_element_type
+      end
       self
     end
 
     def self.from_enumerable elmtype, it
-      new(elmtype).tap {|arr| arr.append_vals it }
+      new(elmtype).tap { |arr| arr.append_vals it }
     end
 
     private
@@ -76,5 +80,14 @@ module GLib
         warn "WARNING: Element sizes do not match"
       end
     end
+
+    def guess_element_type
+      case get_element_size
+      when 1 then :uint8
+      when 2 then :uint16
+      when 4 then :uint32
+      when 8 then :uint64
+      end
+    end
   end
 end

data/lib/ffi-glib/array_methods.rb

@@ -3,7 +3,7 @@ module GLib
   module ArrayMethods
     # Re-implementation of the g_array_index and g_ptr_array_index macros
     def index idx
-      if idx >= length or idx < 0
+      if idx >= length || idx < 0
         raise IndexError, "Index #{idx} outside of bounds 0..#{length - 1}"
       end
       ptr = GirFFI::InOutPointer.new element_type, data_ptr + idx * element_size

data/lib/ffi-glib/list.rb

@@ -8,7 +8,7 @@ module GLib
     include ListMethods
 
     def self.from_enumerable type, arr
-      arr.inject(new type) { |lst, val| lst.append val }
+      arr.reduce(new type) { |lst, val| lst.append val }
     end
 
     def append data

data/lib/ffi-glib/list_methods.rb

@@ -55,7 +55,7 @@ module GLib
     end
 
     def next_element
-      return if !@current
+      return unless @current
       element = @current.head
       @current = @current.tail
       element

data/lib/ffi-glib/main_loop.rb

@@ -0,0 +1,51 @@
+require 'singleton'
+
+GLib.load_class :MainLoop
+
+module GLib
+  # Overrides for GMainLoop, GLib's event loop
+  class MainLoop
+    # Class encepsulationg logic for running an idle handler to make Ruby code
+    # run during GLib's event loop.
+    class ThreadEnabler
+      include Singleton
+
+      FRAMERATE = 25
+      DEFAULT_TIMEOUT = 1000 / FRAMERATE
+
+      def initialize timeout = DEFAULT_TIMEOUT
+        @timeout = timeout
+      end
+
+      def setup_idle_handler
+        @handler_id ||= GLib.timeout_add(GLib::PRIORITY_DEFAULT,
+                                         @timeout, handler_proc,
+                                         nil, nil)
+      end
+
+      private
+
+      def handler_proc
+        proc do
+          Thread.pass
+          true
+        end
+      end
+    end
+
+    setup_instance_method "run_with_thread_enabler"
+
+    def run_with_thread_enabler
+      case RUBY_ENGINE
+      when 'jruby'
+      when 'rbx'
+      else # 'ruby' most likely
+        ThreadEnabler.instance.setup_idle_handler
+      end
+      run_without_thread_enabler
+    end
+
+    alias_method :run_without_thread_enabler, :run
+    alias_method :run, :run_with_thread_enabler
+  end
+end

data/lib/ffi-glib/ptr_array.rb

@@ -26,7 +26,7 @@ module GLib
     end
 
     def self.from_enumerable type, it
-      new(type).tap {|arr| arr.add_array it}
+      new(type).tap { |arr| arr.add_array it }
     end
 
     def self.add array, data
@@ -44,7 +44,7 @@ module GLib
     end
 
     def add_array ary
-      ary.each {|item| add item}
+      ary.each { |item| add item }
     end
 
     def data_ptr

data/lib/ffi-glib/s_list.rb

@@ -8,7 +8,7 @@ module GLib
     include ListMethods
 
     def self.from_enumerable type, arr
-      arr.reverse.inject(new type) { |lst, val| lst.prepend val }
+      arr.reverse.reduce(new type) { |lst, val| lst.prepend val }
     end
 
     def prepend data

data/lib/ffi-glib/variant.rb

@@ -10,10 +10,10 @@ module GLib
     end
 
     def self.constructor_wrap ptr
-      super.tap {|variant| variant.ref }
+      super.tap { |variant| variant.ref }
     end
 
-    alias get_string_without_override get_string
-    alias get_string get_string_with_override
+    alias_method :get_string_without_override, :get_string
+    alias_method :get_string, :get_string_with_override
   end
 end

data/lib/ffi-glib.rb

@@ -10,6 +10,7 @@ require 'ffi-glib/error'
 require 'ffi-glib/hash_table'
 require 'ffi-glib/iconv'
 require 'ffi-glib/list'
+require 'ffi-glib/main_loop'
 require 'ffi-glib/ptr_array'
 require 'ffi-glib/s_list'
 require 'ffi-glib/strv'

data/lib/ffi-gobject/initially_unowned.rb

@@ -7,7 +7,7 @@ module GObject
     # 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}
+      super.tap { |obj| ::GObject::Lib.g_object_ref_sink obj }
     end
   end
 end

data/lib/ffi-gobject/object.rb

@@ -3,22 +3,21 @@ 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
-      if respond_to?("get_#{method}")
-        return send("get_#{method}", *args)
-      end
-      if method.to_s =~ /(.*)=$/ && respond_to?("set_#{$1}")
-        return send("set_#{$1}", *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 signal_connect event, &block
-      GObject.signal_connect(self, event, &block)
+    def signal_connect event, data = nil, &block
+      GObject.signal_connect(self, event, data, &block)
     end
 
     setup_instance_method "get_property"
@@ -62,11 +61,14 @@ module GObject
       GObject::ObjectClass.wrap(to_ptr.get_pointer 0)
     end
 
-    alias get_property_without_override get_property
-    alias get_property get_property_with_override
+    alias_method :get_property_without_override, :get_property
+    alias_method :get_property, :get_property_with_override
+
+    alias_method :set_property_without_override, :set_property
+    alias_method :set_property, :set_property_with_override
 
-    alias set_property_without_override set_property
-    alias set_property set_property_with_override
+    setup_instance_method 'is_floating'
+    alias_method :floating?, :is_floating
 
     private
 

data/lib/ffi-gobject/ruby_closure.rb

@@ -32,16 +32,17 @@ module GObject
 
       closure = wrap(new_simple(self::Struct.size, nil).to_ptr)
       closure.block = block
-      closure.set_marshal Proc.new {|*args| marshaller(*args)}
+      closure.set_marshal proc { |*args| marshaller(*args) }
 
       closure
     end
 
     def self.marshaller closure, return_value, param_values, _invocation_hint, _marshal_data
+      # TODO: Improve by registering RubyClosure as a GObject type
       rclosure = wrap(closure.to_ptr)
       param_values ||= []
 
-      args = param_values.map {|value| value.get_value }
+      args = param_values.map { |value| value.get_value }
 
       result = rclosure.invoke_block(*args)
 

data/lib/ffi-gobject/value.rb

@@ -5,10 +5,7 @@ module GObject
   class Value
     # TODO: Give more generic name
     def set_ruby_value val
-      if current_gtype == 0
-        init_for_ruby_value val
-      end
-
+      init_for_ruby_value val if current_gtype == 0
       set_value val
     end
 
@@ -35,25 +32,22 @@ module GObject
       TYPE_VARIANT => [:get_variant,       :set_variant]
     }
 
-    def value= val
-      set_value val
-    end
-
     def set_value val
       send set_method, val
-      self
     end
 
+    alias_method :value=, :set_value
+
     CLASS_TO_GTYPE_MAP = {
-      true => TYPE_BOOLEAN,
-      false => TYPE_BOOLEAN,
+      TrueClass => TYPE_BOOLEAN,
+      FalseClass => TYPE_BOOLEAN,
       Integer => TYPE_INT,
       String => TYPE_STRING
     }
 
     def init_for_ruby_value val
       CLASS_TO_GTYPE_MAP.each do |klass, type|
-        if klass === val
+        if val.is_a? klass
           init type
           return self
         end
@@ -88,7 +82,7 @@ module GObject
 
     # TODO: Give more generic name
     def self.wrap_ruby_value val
-      new.set_ruby_value val
+      new.tap { |gv| gv.set_ruby_value val }
     end
 
     def self.from val
@@ -104,7 +98,7 @@ module GObject
 
     def self.for_g_type g_type
       return nil if g_type == TYPE_NONE
-      new.tap {|it| it.init g_type }
+      new.tap { |it| it.init g_type }
     end
 
     # TODO: Combine with wrap_ruby_value
@@ -131,7 +125,7 @@ module GObject
     end
 
     def check_type_compatibility val
-      if !GObject::Value.type_compatible(GObject.type_from_instance(val), current_gtype)
+      unless GObject::Value.type_compatible(GObject.type_from_instance(val), current_gtype)
         raise ArgumentError, "#{val.class} is incompatible with #{current_gtype_name}"
       end
     end
@@ -142,6 +136,8 @@ module GObject
         GLib::Strv.wrap boxed
       when TYPE_HASH_TABLE
         GLib::HashTable.wrap [:gpointer, :gpointer], boxed
+      when TYPE_ARRAY
+        GLib::Array.wrap nil, boxed
       else
         current_gtype_class.wrap(boxed) unless boxed.null?
       end
@@ -157,7 +153,7 @@ module GObject
 
     def method_map_entry
       METHOD_MAP[current_gtype] || METHOD_MAP[current_fundamental_type] ||
-        fail("No method map entry for #{current_gtype_name}")
+        raise("No method map entry for #{current_gtype_name}")
     end
   end
 end

data/lib/ffi-gobject.rb

@@ -15,22 +15,6 @@ 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
-  end
-
-  def self.object_ref_sink obj
-    Lib.g_object_ref_sink obj.to_ptr
-  end
-
-  def self.object_unref obj
-    Lib.g_object_unref obj.to_ptr
-  end
-
-  def self.object_is_floating obj
-    Lib.g_object_is_floating obj.to_ptr
-  end
-
   def self.type_from_instance_pointer inst_ptr
     return nil if inst_ptr.null?
     klsptr = inst_ptr.get_pointer 0
@@ -70,12 +54,12 @@ module GObject
     return_gvalue
   end
 
-  def self.signal_connect object, detailed_signal, data=nil, &block
+  def self.signal_connect object, detailed_signal, data = nil, &block
     raise ArgumentError, "Block needed" unless block_given?
     signal_name, _ = detailed_signal.split('::')
     sig_info = object.class.find_signal signal_name
 
-    closure = sig_info.wrap_in_closure {|*args| block.call(*args << data) }
+    closure = sig_info.wrap_in_closure { |*args| block.call(*args << data) }
 
     # TODO: Provide _after variant
     signal_connect_closure object, detailed_signal, closure, false
@@ -96,12 +80,10 @@ module GObject
 
   # NOTE: This Lib module is set up in `gir_ffi-base/gobject/lib.rb`.
   module Lib
-    attach_function :g_object_ref, [:pointer], :void
     attach_function :g_object_ref_sink, [:pointer], :void
-    attach_function :g_object_unref, [:pointer], :void
-    attach_function :g_object_is_floating, [:pointer], :bool
 
     attach_function :g_array_get_type, [], :size_t
+    attach_function :g_byte_array_get_type, [], :size_t
     attach_function :g_hash_table_get_type, [], :size_t
     attach_function :g_strv_get_type, [], :size_t
 
@@ -117,6 +99,7 @@ module GObject
   end
 
   TYPE_ARRAY = Lib.g_array_get_type
+  TYPE_BYTE_ARRAY = Lib.g_byte_array_get_type
   TYPE_HASH_TABLE = Lib.g_hash_table_get_type
   TYPE_STRV = Lib.g_strv_get_type
 end

data/lib/ffi-gobject_introspection/i_base_info.rb

@@ -2,7 +2,7 @@ module GObjectIntrospection
   # Wraps GIBaseInfo struct, the base \type for all info types.
   # Decendant types will be implemented as needed.
   class IBaseInfo
-    def initialize ptr, lib=Lib
+    def initialize ptr, lib = Lib
       raise ArgumentError, "ptr must not be null" if ptr.null?
 
       unless defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
@@ -94,7 +94,7 @@ module GObjectIntrospection
     end
 
     def safe_namespace
-      namespace.gsub(/^(.)/) { $1.upcase }
+      namespace.gsub(/^./, &:upcase)
     end
 
     def container
@@ -112,7 +112,7 @@ module GObjectIntrospection
     end
 
     def == other
-      Lib.g_base_info_equal @gobj, other.to_ptr
+      other.is_a?(IBaseInfo) && Lib.g_base_info_equal(@gobj, other)
     end
   end
 end

data/lib/ffi-gobject_introspection/i_interface_info.rb

@@ -23,6 +23,7 @@ module GObjectIntrospection
 
     ##
     build_array_method :properties, :property
+    build_finder_method :find_property, :n_properties
 
     def get_n_methods
       Lib.g_interface_info_get_n_methods @gobj
@@ -80,6 +81,5 @@ module GObjectIntrospection
     def iface_struct
       IStructInfo.wrap(Lib.g_interface_info_get_iface_struct @gobj)
     end
-
   end
 end

data/lib/ffi-gobject_introspection/i_repository.rb

@@ -72,7 +72,7 @@ module GObjectIntrospection
       Lib.g_type_tag_to_string type
     end
 
-    def require namespace, version=nil, flags=0
+    def require namespace, version = nil, flags = 0
       errpp = FFI::MemoryPointer.new(:pointer).write_pointer nil
 
       Lib.g_irepository_require @gobj, namespace, version, flags, errpp

data/lib/ffi-gobject_introspection/lib.rb

@@ -7,7 +7,7 @@ module GObjectIntrospection
     ffi_lib "girepository-1.0"
 
     # IRepository
-    enum :IRepositoryLoadFlags, [:LAZY, (1<<0)]
+    enum :IRepositoryLoadFlags, [:LAZY, (1 << 0)]
 
     attach_function :g_irepository_get_default, [], :pointer
     attach_function :g_irepository_prepend_search_path, [:string], :void

data/lib/gir_ffi/arg_helper.rb

@@ -20,7 +20,7 @@ module GirFFI
       def fetch ptr
         return if ptr.null?
         key = ptr.address
-        if @store.has_key? key
+        if @store.key? key
           @store[key]
         else
           ptr
@@ -74,7 +74,7 @@ module GirFFI
 
     def self.cast_uint32_to_int32 val
       if val >= 0x80000000
-        -(0x100000000-val)
+        -(0x100000000 - val)
       else
         val
       end

data/lib/gir_ffi/builder.rb

@@ -21,7 +21,7 @@ module GirFFI
       build_class info
     end
 
-    def self.build_module namespace, version=nil
+    def self.build_module namespace, version = nil
       Builders::ModuleBuilder.new(namespace, version).generate
     end