gir_ffi 0.7.7 → 0.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d42de354fa7299aa1335fbc7853d71c290e40672
-  data.tar.gz: 5ac34874e3b063d78efae9e6d866d1c53250a139
+  metadata.gz: 58dffbf9a2115d4ddfe8ca620557382d27510bb5
+  data.tar.gz: 6f0e46d81b16c5d29468acc9fce70e4249b44f37
 SHA512:
-  metadata.gz: 24484386533238755050906dc1d1dbbf31e4d8baf49fb739a9c42cb85176a561f3b280e83eaa06ff249cbb3f77c8b08867f532f0db926618e8be67ad8bb96f19
-  data.tar.gz: 35251a7d050dbf35c96ebb59c6c06588d190551a68629df365267c1723cb85a1d813e1e0bfff1b7850ef7661fecaed0453d6f4bf813968c8b3081e65e1c08538
+  metadata.gz: 80c91f162cc4b515d85a77de746ba8305c1a8f241bf28e739bbbb46bd5e34ee4029f553ff57764f7824a33dedcb2486931c979a3d612432601e92aa2867e02d3
+  data.tar.gz: e5e38438a0b57c2ac477a60d464dbf7e0547f74ae7b8326c54f79a486c6bbc205e7e90f484a95a9c628abd927023b771c94b1c0f1272537ac480dcc85a958cdf

data/Changelog.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.7.8 / 2014-12-09
+
+* Support constants with a falsy value
+* Support type aliases that resolve to a type that is not introspectable
+* Support callback arguments with direction :inout
+* Provide GObject.signal_connect_after and GObject::Object.signal_connect_after
+* Handle setting GValues (and hence, properties) that have enum values
+* Various refactorings & coding style cleanups
+
 ## 0.7.7 / 2014-10-21
 
 * Handle introspecting boolean constants

data/lib/ffi-glib/array.rb

@@ -77,7 +77,7 @@ module GLib
 
     def check_element_size_match
       unless calculated_element_size == get_element_size
-        warn "WARNING: Element sizes do not match"
+        warn 'WARNING: Element sizes do not match'
       end
     end
 

data/lib/ffi-glib/error.rb

@@ -3,8 +3,7 @@ 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
-    GIR_FFI_DOMAIN = GLib.quark_from_string("gir_ffi")
+    GIR_FFI_DOMAIN = GLib.quark_from_string('gir_ffi')
 
     def self.from_exception ex
       new_literal GIR_FFI_DOMAIN, 0, ex.message

data/lib/ffi-glib/hash_table.rb

@@ -56,7 +56,7 @@ module GLib
       when :utf8
         FFI::Function.new(:uint,
                           [:pointer],
-                          find_support_function("g_str_hash"))
+                          find_support_function('g_str_hash'))
       else
         nil
       end
@@ -67,7 +67,7 @@ module GLib
       when :utf8
         FFI::Function.new(:int,
                           [:pointer, :pointer],
-                          find_support_function("g_str_equal"))
+                          find_support_function('g_str_equal'))
       else
         nil
       end

data/lib/ffi-glib/variant.rb

@@ -3,7 +3,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/base.rb

@@ -1,26 +1,26 @@
 # Preload type contants
 module GObject
-  TYPE_INVALID = type_from_name("invalid")
-  TYPE_NONE = type_from_name("void")
-  TYPE_INTERFACE = type_from_name("GInterface")
-  TYPE_CHAR = type_from_name("gchar")
-  TYPE_UCHAR = type_from_name("guchar")
-  TYPE_BOOLEAN = type_from_name("gboolean")
-  TYPE_INT = type_from_name("gint")
-  TYPE_UINT = type_from_name("guint")
-  TYPE_LONG = type_from_name("glong")
-  TYPE_ULONG = type_from_name("gulong")
-  TYPE_INT64 = type_from_name("gint64")
-  TYPE_UINT64 = type_from_name("guint64")
-  TYPE_ENUM = type_from_name("GEnum")
-  TYPE_FLAGS = type_from_name("GFlags")
-  TYPE_FLOAT = type_from_name("gfloat")
-  TYPE_DOUBLE = type_from_name("gdouble")
-  TYPE_STRING = type_from_name("gchararray")
-  TYPE_POINTER = type_from_name("gpointer")
-  TYPE_BOXED = type_from_name("GBoxed")
-  TYPE_PARAM = type_from_name("GParam")
-  TYPE_OBJECT = type_from_name("GObject")
-  TYPE_GTYPE = type_from_name("GType")
-  TYPE_VARIANT = type_from_name("GVariant")
+  TYPE_INVALID = type_from_name('invalid')
+  TYPE_NONE = type_from_name('void')
+  TYPE_INTERFACE = type_from_name('GInterface')
+  TYPE_CHAR = type_from_name('gchar')
+  TYPE_UCHAR = type_from_name('guchar')
+  TYPE_BOOLEAN = type_from_name('gboolean')
+  TYPE_INT = type_from_name('gint')
+  TYPE_UINT = type_from_name('guint')
+  TYPE_LONG = type_from_name('glong')
+  TYPE_ULONG = type_from_name('gulong')
+  TYPE_INT64 = type_from_name('gint64')
+  TYPE_UINT64 = type_from_name('guint64')
+  TYPE_ENUM = type_from_name('GEnum')
+  TYPE_FLAGS = type_from_name('GFlags')
+  TYPE_FLOAT = type_from_name('gfloat')
+  TYPE_DOUBLE = type_from_name('gdouble')
+  TYPE_STRING = type_from_name('gchararray')
+  TYPE_POINTER = type_from_name('gpointer')
+  TYPE_BOXED = type_from_name('GBoxed')
+  TYPE_PARAM = type_from_name('GParam')
+  TYPE_OBJECT = type_from_name('GObject')
+  TYPE_GTYPE = type_from_name('GType')
+  TYPE_VARIANT = type_from_name('GVariant')
 end

data/lib/ffi-gobject/object.rb

@@ -3,7 +3,7 @@ GObject.load_class :Object
 module GObject
   # Overrides for GObject, GObject's generic base class.
   class Object
-    setup_method "new"
+    setup_method 'new'
 
     # TODO: Generate accessor methods from GIR at class definition time
     def method_missing method, *args
@@ -20,8 +20,12 @@ module GObject
       GObject.signal_connect(self, event, data, &block)
     end
 
-    setup_instance_method "get_property"
-    setup_instance_method "set_property"
+    def signal_connect_after event, data = nil, &block
+      GObject.signal_connect_after(self, event, data, &block)
+    end
+
+    setup_instance_method 'get_property'
+    setup_instance_method 'set_property'
 
     def get_property_extended property_name
       gvalue = get_property property_name

data/lib/ffi-gobject/value.rb

@@ -14,7 +14,7 @@ module GObject
       TYPE_BOXED   => [:get_boxed,         :set_boxed],
       TYPE_CHAR    => [:get_char,          :set_char],
       TYPE_DOUBLE  => [:get_double,        :set_double],
-      TYPE_ENUM    => [:get_enum_enhanced, :set_enum],
+      TYPE_ENUM    => [:get_enum_enhanced, :set_enum_enhanced],
       TYPE_FLAGS   => [:get_flags,         :set_flags],
       TYPE_FLOAT   => [:get_float,         :set_float],
       TYPE_GTYPE   => [:get_gtype,         :set_gtype],
@@ -116,6 +116,11 @@ module GObject
       set_instance val
     end
 
+    def set_enum_enhanced val
+      val = current_gtype_class[val] if val.is_a? Symbol
+      set_enum val
+    end
+
     def get_enum_enhanced
       current_gtype_class.wrap(get_enum)
     end

data/lib/ffi-gobject.rb

@@ -18,8 +18,7 @@ module GObject
   def self.type_from_instance_pointer inst_ptr
     return nil if inst_ptr.null?
     klsptr = inst_ptr.get_pointer 0
-    # TODO: Cache the message name somewhere.
-    klsptr.send "get_#{GirFFI::TypeMap::TAG_TYPE_MAP[:GType]}", 0
+    GirFFI::InOutPointer.new(:GType, klsptr).to_value
   end
 
   def self.type_from_instance instance
@@ -54,18 +53,22 @@ module GObject
     return_gvalue
   end
 
-  def self.signal_connect object, detailed_signal, data = nil, &block
-    raise ArgumentError, "Block needed" unless block_given?
+  def self.signal_connect object, detailed_signal, data = nil, after = false, &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) }
 
-    # TODO: Provide _after variant
-    signal_connect_closure object, detailed_signal, closure, false
+    signal_connect_closure object, detailed_signal, closure, after
+  end
+
+  def self.signal_connect_after object, detailed_signal, data = nil, &block
+    signal_connect object, detailed_signal, data, true, &block
   end
 
   # Smells of :reek:LongParameterList: due to the C interface.
+  # rubocop:disable Metrics/ParameterLists
   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)

data/lib/ffi-gobject_introspection/i_base_info.rb

@@ -3,7 +3,7 @@ module GObjectIntrospection
   # Decendant types will be implemented as needed.
   class IBaseInfo
     def initialize ptr, lib = Lib
-      raise ArgumentError, "ptr must not be null" if ptr.null?
+      raise ArgumentError, 'ptr must not be null' if ptr.null?
 
       unless defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
         ObjectSpace.define_finalizer self, self.class.make_finalizer(lib, ptr)
@@ -39,7 +39,7 @@ module GObjectIntrospection
     def self.build_array_method method, single = nil
       method = method.to_s
       single ||= method.to_s[0..-2]
-      count = method.sub(/^(get_)?/, "\\1n_")
+      count = method.sub(/^(get_)?/, '\\1n_')
       class_eval <<-CODE
         def #{method}
           (0..(#{count} - 1)).map do |i|
@@ -67,7 +67,7 @@ module GObjectIntrospection
     #
     def self.build_finder_method method, counter = nil, fetcher = nil
       method = method.to_s
-      single = method.sub(/^find_/, "")
+      single = method.sub(/^find_/, '')
       counter ||= "n_#{single}s"
       fetcher ||= "#{single}"
       class_eval <<-CODE

data/lib/ffi-gobject_introspection/i_constant_info.rb

@@ -18,7 +18,7 @@ module GObjectIntrospection
     def value
       case type_tag
       when :utf8
-        raw_value.force_encoding("utf-8")
+        raw_value.force_encoding('utf-8')
       when :gboolean
         raw_value != 0
       else

data/lib/ffi-gobject_introspection/i_repository.rb

@@ -21,6 +21,7 @@ require 'ffi-gobject_introspection/i_value_info'
 require 'ffi-gobject_introspection/i_union_info'
 require 'ffi-gobject_introspection/i_enum_info'
 require 'ffi-gobject_introspection/i_flags_info'
+require 'ffi-gobject_introspection/i_unresolved_info'
 
 GObject.type_init
 
@@ -30,6 +31,8 @@ module GObjectIntrospection
   # This class wraps the GIRepository struct.
   class IRepository
     # Map info type to class. Default is IBaseInfo.
+    # SMELL: This doesn't really belong here, since it is used by IBaseInfo and
+    # descendants as well.
     TYPEMAP = {
       invalid:                  IBaseInfo,
       function:                 IFunctionInfo,
@@ -51,7 +54,7 @@ module GObjectIntrospection
       field:                    IFieldInfo,
       arg:                      IArgInfo,
       type:                     ITypeInfo,
-      unresolved:               IBaseInfo
+      unresolved:               IUnresolvedInfo
     }
 
     def initialize

data/lib/ffi-gobject_introspection/i_type_info.rb

@@ -36,7 +36,7 @@ module GObjectIntrospection
     end
 
     def name
-      raise "Should not call this for ITypeInfo"
+      raise 'Should not call this for ITypeInfo'
     end
   end
 end

data/lib/ffi-gobject_introspection/i_unresolved_info.rb

@@ -0,0 +1,7 @@
+require 'ffi-gobject_introspection/i_base_info'
+
+module GObjectIntrospection
+  # Wraps a GIBaseInfo struct in the case where the info type is :unresolved.
+  class IUnresolvedInfo < IBaseInfo
+  end
+end

data/lib/ffi-gobject_introspection/lib.rb

@@ -4,7 +4,7 @@ module GObjectIntrospection
   # Module for attaching functions from the girepository library
   module Lib
     extend FFI::Library
-    ffi_lib "girepository-1.0"
+    ffi_lib 'girepository-1.0'
 
     # IRepository
     enum :IRepositoryLoadFlags, [:LAZY, (1 << 0)]

data/lib/gir_ffi/builders/argument_builder.rb

@@ -141,7 +141,7 @@ module GirFFI
 
       def ingoing_convertor
         if skipped?
-          NullConvertor.new("0")
+          NullConvertor.new('0')
         elsif closure?
           ClosureToPointerConvertor.new(name)
         elsif @type_info.needs_ruby_to_c_conversion_for_functions?

data/lib/gir_ffi/builders/c_to_ruby_convertor.rb

@@ -1,36 +1,44 @@
-# Builder that generates code to convert values from C to Ruby. Used by
-# argument builders.
-class GirFFI::Builders::CToRubyConvertor
-  def initialize type_info, argument_name, length_arg
-    @type_info = type_info
-    @argument_name = argument_name
-    @length_arg = length_arg
-  end
+module GirFFI
+  module Builders
+    # Builder that generates code to convert values from C to Ruby. Used by
+    # argument builders.
+    class CToRubyConvertor
+      def initialize type_info, argument_name, length_arg
+        @type_info = type_info
+        @argument_name = argument_name
+        @length_arg = length_arg
+      end
 
-  def conversion
-    case @type_info.flattened_tag
-    when :utf8, :filename
-      "#{@argument_name}.to_utf8"
-    else
-      "#{@type_info.argument_class_name}.wrap(#{conversion_arguments})"
-    end
-  end
+      def conversion
+        case @type_info.flattened_tag
+        when :utf8, :filename
+          "#{@argument_name}.to_utf8"
+        else
+          "#{@type_info.argument_class_name}.wrap(#{conversion_argument_list})"
+        end
+      end
 
-  private
+      private
 
-  def conversion_arguments
-    if @type_info.flattened_tag == :c
-      "#{@type_info.element_type.inspect}, #{array_size}, #{@argument_name}"
-    else
-      @type_info.extra_conversion_arguments.map(&:inspect).push(@argument_name).join(", ")
-    end
-  end
+      def conversion_argument_list
+        conversion_arguments.join(', ')
+      end
+
+      def conversion_arguments
+        if @type_info.flattened_tag == :c
+          [@type_info.element_type.inspect, array_size, @argument_name]
+        else
+          @type_info.extra_conversion_arguments.map(&:inspect).push(@argument_name)
+        end
+      end
 
-  def array_size
-    if @length_arg
-      @length_arg
-    else
-      @type_info.array_fixed_size
+      def array_size
+        if @length_arg
+          @length_arg
+        else
+          @type_info.array_fixed_size
+        end
+      end
     end
   end
 end

data/lib/gir_ffi/builders/callback_argument_builder.rb

@@ -16,39 +16,47 @@ module GirFFI
         @pre_converted_name ||= new_variable
       end
 
+      def out_parameter_name
+        @out_parameter_name ||=
+          if direction == :inout
+            new_variable
+          else
+            pre_converted_name
+          end
+      end
+
       def call_argument_name
-        if direction == :in
+        if [:in, :inout].include? direction
           pre_converted_name unless array_arg
         end
       end
 
       def capture_variable_name
-        result_name if direction == :out
+        result_name if [:out, :inout].include? direction unless array_arg
       end
 
       def pre_conversion
         case direction
         when :in
-          ["#{pre_converted_name} = #{pre_convertor.conversion}"]
+          [ingoing_pre_conversion]
         when :out
-          ["#{pre_converted_name} = #{out_parameter_preparation}"]
+          [out_parameter_preparation]
+        when :inout
+          [out_parameter_preparation, ingoing_pre_conversion]
         when :error
-          [
-            "#{pre_converted_name} = #{out_parameter_preparation}",
-            "begin"
-          ]
+          [out_parameter_preparation, 'begin']
         end
       end
 
       def post_conversion
         case direction
-        when :out
+        when :out, :inout
           [outgoing_post_conversion]
         when :error
           [
             "rescue => #{result_name}",
             outgoing_post_conversion,
-            "end"
+            'end'
           ]
         else
           []
@@ -61,15 +69,23 @@ module GirFFI
         @result_name ||= new_variable
       end
 
+      def pre_convertor_argument
+        if direction == :inout
+          "#{out_parameter_name}.to_value"
+        else
+          method_argument_name
+        end
+      end
+
       def pre_convertor
         @pre_convertor ||= if closure?
-                             ClosureConvertor.new(method_argument_name)
+                             ClosureConvertor.new(pre_convertor_argument)
                            elsif needs_c_to_ruby_conversion?
                              CToRubyConvertor.new(type_info,
-                                                  method_argument_name,
+                                                  pre_convertor_argument,
                                                   length_argument_name)
                            else
-                             NullConvertor.new(method_argument_name)
+                             NullConvertor.new(pre_convertor_argument)
                            end
       end
 
@@ -77,34 +93,48 @@ module GirFFI
         type_info.needs_c_to_ruby_conversion_for_callbacks?
       end
 
+      def ingoing_pre_conversion
+        "#{pre_converted_name} = #{pre_convertor.conversion}"
+      end
+
       def outgoing_post_conversion
-        "#{pre_converted_name}.set_value #{outgoing_convertor.conversion}"
+        "#{out_parameter_name}.set_value #{post_convertor.conversion}"
       end
 
-      def outgoing_convertor
-        @outgoing_convertor ||= if type_info.needs_ruby_to_c_conversion_for_callbacks?
-                                  RubyToCConvertor.new(type_info, result_name)
-                                else
-                                  NullConvertor.new(result_name)
-                                end
+      def post_convertor
+        @post_convertor ||= if type_info.needs_ruby_to_c_conversion_for_callbacks?
+                              RubyToCConvertor.new(type_info, post_convertor_argument)
+                            else
+                              NullConvertor.new(post_convertor_argument)
+                            end
       end
 
-      def out_parameter_preparation
-        type_spec = type_info.tag_or_class
-        if allocated_by_us?
-          "GirFFI::InOutPointer.new(#{type_spec[1].inspect})" \
-            ".tap { |ptr| #{method_argument_name}.put_pointer 0, ptr }"
+      def post_convertor_argument
+        if array_arg
+          "#{array_arg.capture_variable_name}.length"
         else
-          "GirFFI::InOutPointer.new(#{type_spec.inspect}, #{method_argument_name})"
+          result_name
         end
       end
 
+      def out_parameter_preparation
+        type_spec = type_info.tag_or_class
+        value = if allocated_by_us?
+                  "GirFFI::InOutPointer.new(#{type_spec[1].inspect})" \
+                    ".tap { |ptr| #{method_argument_name}.put_pointer 0, ptr }"
+                else
+                  "GirFFI::InOutPointer.new(#{type_spec.inspect}, #{method_argument_name})"
+                end
+        "#{out_parameter_name} = #{value}"
+      end
+
       # Check if an out argument needs to be allocated by us, the callee. Since
       # caller_allocates is false by default, we must also check that the type
       # is a pointer. For example, an out parameter of type gint8* will always
       # be allocate by the caller.
       def allocated_by_us?
-        !@arginfo.caller_allocates? &&
+        direction == :out &&
+          !@arginfo.caller_allocates? &&
           type_info.pointer? &&
           ![:object, :zero_terminated].include?(specialized_type_tag)
       end

data/lib/gir_ffi/builders/closure_convertor.rb

@@ -1,11 +1,15 @@
-# Builder that generates code to convert closure arguments ('user data') from
-# C to Ruby. Used by argument builders.
-class GirFFI::Builders::ClosureConvertor
-  def initialize argument_name
-    @argument_name = argument_name
-  end
+module GirFFI
+  module Builders
+    # Builder that generates code to convert closure arguments ('user data')
+    # from C to Ruby. Used by argument builders.
+    class ClosureConvertor
+      def initialize argument_name
+        @argument_name = argument_name
+      end
 
-  def conversion
-    "GirFFI::ArgHelper::OBJECT_STORE.fetch(#{@argument_name})"
+      def conversion
+        "GirFFI::ArgHelper::OBJECT_STORE.fetch(#{@argument_name})"
+      end
+    end
   end
 end

data/lib/gir_ffi/builders/closure_to_pointer_convertor.rb

@@ -1,11 +1,15 @@
-# Builder that generates code to convert closure arguments ('user data') from
-# Ruby to C. Used by argument builders.
-class GirFFI::Builders::ClosureToPointerConvertor
-  def initialize argument_name
-    @argument_name = argument_name
-  end
+module GirFFI
+  module Builders
+    # Builder that generates code to convert closure arguments ('user data')
+    # from Ruby to C. Used by argument builders.
+    class ClosureToPointerConvertor
+      def initialize argument_name
+        @argument_name = argument_name
+      end
 
-  def conversion
-    "GirFFI::InPointer.from_closure_data(#{@argument_name})"
+      def conversion
+        "GirFFI::InPointer.from_closure_data(#{@argument_name})"
+      end
+    end
   end
 end

data/lib/gir_ffi/builders/constructor_result_convertor.rb

@@ -1,10 +1,14 @@
-# Builds conversion code for the result of a GObject constructor method.
-class GirFFI::Builders::ConstructorResultConvertor
-  def initialize argument_name
-    @argument_name = argument_name
-  end
+module GirFFI
+  module Builders
+    # Builds conversion code for the result of a GObject constructor method.
+    class ConstructorResultConvertor
+      def initialize argument_name
+        @argument_name = argument_name
+      end
 
-  def conversion
-    "self.constructor_wrap(#{@argument_name})"
+      def conversion
+        "self.constructor_wrap(#{@argument_name})"
+      end
+    end
   end
 end

data/lib/gir_ffi/builders/field_builder.rb

@@ -86,7 +86,7 @@ module GirFFI
       end
 
       def field_argument_info
-        @field_argument_info ||= FieldArgumentInfo.new "value", field_type
+        @field_argument_info ||= FieldArgumentInfo.new 'value', field_type
       end
 
       def return_value_builder

data/lib/gir_ffi/builders/function_builder.rb

@@ -71,7 +71,7 @@ module GirFFI
 
       def function_call_arguments
         ca = @argument_builder_collection.call_argument_names
-        ca.unshift "self" if @info.method?
+        ca.unshift 'self' if @info.method?
         ca
       end
     end

data/lib/gir_ffi/builders/mapping_method_builder.rb

@@ -35,7 +35,7 @@ module GirFFI
       end
 
       def method_name
-        "call_with_argument_mapping"
+        'call_with_argument_mapping'
       end
 
       def method_arguments