gir_ffi 0.5.1 → 0.5.2

data/History.txt

@@ -1,3 +1,11 @@
+== 0.5.2 / 2013-04-23
+
+* Handle signal details in GObject.signal_connect and .signal_emit
+* Make GValue#set_value check object GType compatibility
+* Eliminate GObject::Helper module
+* Handle more argument types
+* Support Ruby 2.0.0
+
 == 0.5.1 / 2013-02-01
 
 * Properly handle zero-terminated arrays of :filename

data/lib/ffi-glib/array.rb

@@ -40,7 +40,7 @@ module GLib
     end
 
     def get_element_size
-      GLib.array_get_element_size self
+      Lib.g_array_get_element_size self
     end
 
     def self.wrap elmttype, ptr

data/lib/ffi-glib.rb

@@ -22,24 +22,19 @@ module GLib
 
     attach_function :g_list_append, [:pointer, :pointer], :pointer
 
-    attach_function :g_hash_table_foreach,
-      [:pointer, HFunc, :pointer], :void
-    attach_function :g_hash_table_new,
-      [HashFunc, EqualFunc], :pointer
-    attach_function :g_hash_table_insert,
-      [:pointer, :pointer, :pointer], :void
+    attach_function :g_hash_table_foreach, [:pointer, HFunc, :pointer], :void
+    attach_function :g_hash_table_new, [HashFunc, EqualFunc], :pointer
+    attach_function :g_hash_table_insert, [:pointer, :pointer, :pointer], :void
 
     attach_function :g_byte_array_new, [], :pointer
-    attach_function :g_byte_array_append,
-      [:pointer, :pointer, :uint], :pointer
+    attach_function :g_byte_array_append, [:pointer, :pointer, :uint], :pointer
 
     attach_function :g_array_new, [:int, :int, :uint], :pointer
-    attach_function :g_array_append_vals,
-      [:pointer, :pointer, :uint], :pointer
+    attach_function :g_array_append_vals, [:pointer, :pointer, :uint], :pointer
+    attach_function :g_array_get_element_size, [:pointer], :uint
 
     attach_function :g_ptr_array_new, [], :pointer
     attach_function :g_ptr_array_add, [:pointer, :pointer], :void
-    attach_function :g_ptr_array_foreach, [:pointer, Func, :pointer],
-      :pointer
+    attach_function :g_ptr_array_foreach, [:pointer, Func, :pointer], :pointer
   end
 end

data/lib/ffi-gobject/closure.rb

@@ -4,10 +4,7 @@ module GObject
   # Overrides for GClosure, GObject's base class for closure objects.
   class Closure
     def set_marshal marshal
-      callback = GirFFI::CallbackHelper.wrap_in_callback_args_mapper("GObject",
-                                                                     "ClosureMarshal",
-                                                                     marshal)
-      GirFFI::CallbackHelper.store_callback callback
+      callback = GirFFI::Callback.from("GObject", "ClosureMarshal", marshal)
       Lib.g_closure_set_marshal self, callback
     end
   end

data/lib/ffi-gobject/object.rb

@@ -14,7 +14,7 @@ module GObject
 
     def get_property_with_override property_name
       type = get_property_type property_name
-      gvalue = Helper.gvalue_for_type_info type
+      gvalue = type.make_g_value
 
       get_property_without_override property_name, gvalue
 
@@ -23,7 +23,7 @@ module GObject
 
     def set_property_with_override property_name, value
       type = get_property_type property_name
-      gvalue = Helper.gvalue_for_type_info type
+      gvalue = type.make_g_value
 
       gvalue.set_value adjust_value_to_type(value, type)
 

data/lib/ffi-gobject/ruby_style.rb

@@ -2,6 +2,7 @@ module GObject
 
   module RubyStyle
 
+    # 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)
@@ -12,6 +13,7 @@ module GObject
       super
     end
 
+    # TODO: Move to definition of GObject::Object
     def signal_connect(event, &block)
       GObject.signal_connect(self, event, &block)
     end

data/lib/ffi-gobject/value.rb

@@ -17,7 +17,8 @@ module GObject
       TYPE_STRING => :set_string,
       TYPE_FLOAT => :set_float,
       TYPE_DOUBLE => :set_double,
-      TYPE_OBJECT => :set_instance,
+      TYPE_PARAM => :set_param,
+      TYPE_OBJECT => :set_instance_enhanced,
       TYPE_BOXED => :set_boxed,
       TYPE_POINTER => :set_pointer,
       TYPE_ENUM => :set_enum
@@ -89,10 +90,27 @@ module GObject
           wrap_ruby_value val
         end
       end
+
+      def for_g_type g_type
+        return nil if g_type == TYPE_NONE
+        self.new.tap {|it| it.init g_type }
+      end
     end
 
     private
 
+    def set_instance_enhanced val
+      check_type_compatibility val
+      set_instance val
+    end
+
+    def check_type_compatibility val
+      return if val.nil?
+      if !GObject::Value.type_compatible(GObject.type_from_instance(val), current_gtype)
+        raise ArgumentError, "#{val.class} is incompatible with #{current_gtype_name}"
+      end
+    end
+
     def get_boxed_enhanced
       boxed = get_boxed
       case current_gtype

data/lib/ffi-gobject.rb

@@ -10,7 +10,6 @@ require 'ffi-gobject/initially_unowned'
 require 'ffi-gobject/closure'
 require 'ffi-gobject/object'
 require 'ffi-gobject/ruby_closure'
-require 'ffi-gobject/helper'
 require 'gir_ffi/builder/type/user_defined'
 
 module GObject
@@ -60,22 +59,28 @@ module GObject
     signal_lookup signal, type_from_instance(object)
   end
 
-  def self.signal_emit object, signal, *args
+  def self.signal_emit object, detailed_signal, *args
+    signal, detail = detailed_signal.split('::')
+    sig_info = object.class.find_signal signal
+
     id = signal_lookup_from_instance signal, object
-    arr = Helper.signal_arguments_to_gvalue_array signal, object, *args
-    rval = Helper.gvalue_for_signal_return_value signal, object
+    detail_quark = GLib.quark_from_string(detail)
+
+    arr = sig_info.signal_arguments_to_gvalue_array object, *args
+    rval = sig_info.gvalue_for_signal_return_value
 
-    Lib.g_signal_emitv arr.values, id, 0, rval
+    Lib.g_signal_emitv arr.values, id, detail_quark, rval
 
     return rval
   end
 
-  def self.signal_connect object, signal, data=nil, &block
-    callback = Helper.signal_callback object.class, signal, &block
+  def self.signal_connect object, detailed_signal, data=nil, &block
+    signal, _ = detailed_signal.split('::')
+    sig_info = object.class.find_signal signal
+    callback = sig_info.signal_callback(&block)
     GirFFI::CallbackHelper.store_callback callback
     data_ptr = GirFFI::ArgHelper.object_to_inptr data
-
-    Lib.g_signal_connect_data object, signal, callback, data_ptr, nil, 0
+    Lib.g_signal_connect_data object, detailed_signal, callback, data_ptr, nil, 0
   end
 
   def self.param_spec_int(name, nick, blurb, minimum, maximum,

data/lib/ffi-gobject_introspection/i_base_info.rb

@@ -33,11 +33,11 @@ module GObjectIntrospection
       single ||= method[0..-2]
       count = method.sub(/^(get_)?/, "\\1n_")
       self.class_eval <<-CODE
-	def #{method}
-	  (0..(#{count} - 1)).map do |i|
-	    #{single} i
-	  end
-	end
+        def #{method}
+          (0..(#{count} - 1)).map do |i|
+            #{single} i
+          end
+        end
       CODE
     end
 

data/lib/ffi-gobject_introspection/i_repository.rb

@@ -95,7 +95,7 @@ module GObjectIntrospection
     # Utility method
     def infos namespace
       (0..(n_infos(namespace) - 1)).map do |idx|
-	info namespace, idx
+        info namespace, idx
       end
     end
 

data/lib/ffi-gobject_introspection/lib.rb

@@ -168,7 +168,7 @@ module GObjectIntrospection
     attach_function :g_union_info_find_method, [:pointer, :string], :pointer
     attach_function :g_union_info_get_size, [:pointer], :int
     attach_function :g_union_info_get_alignment, [:pointer], :int
- 
+
     # IRegisteredTypeInfo
     attach_function :g_registered_type_info_get_type_name, [:pointer], :string
     attach_function :g_registered_type_info_get_type_init, [:pointer], :string

data/lib/gir_ffi/arg_helper.rb

@@ -17,8 +17,8 @@ module GirFFI
     # FIXME: Hideous
     # TODO: Move this implementation to InPointer
     def self.object_to_inptr obj
-      return obj.to_ptr if obj.respond_to? :to_ptr
       return nil if obj.nil?
+      return obj.to_ptr if obj.respond_to? :to_ptr
       return obj if obj.is_a? FFI::Pointer
 
       FFI::Pointer.new(obj.object_id).tap {|ptr|
@@ -96,12 +96,12 @@ module GirFFI
 
     def self.check_error errpp
       err = GLib::Error.wrap(errpp.read_pointer)
-      raise err.message unless err.nil?
+      raise err.message if err
     end
 
     def self.check_fixed_array_size size, arr, name
       unless arr.size == size
-	raise ArgumentError, "#{name} should have size #{size}"
+        raise ArgumentError, "#{name} should have size #{size}"
       end
     end
 

data/lib/gir_ffi/argument_builder.rb

@@ -31,29 +31,33 @@ module GirFFI
     end
 
     def post
-      result = []
       if has_output_value?
-        value = if is_caller_allocated_object?
-                  callarg
-                elsif needs_outgoing_parameter_conversion?
-                  case specialized_type_tag
-                  when :enum, :flags
-                    "#{argument_class_name}[#{output_conversion_arguments}]"
-                  else
-                    "#{argument_class_name}.wrap(#{output_conversion_arguments})"
-                  end
-                elsif is_fixed_length_array?
-                  "#{callarg}.to_sized_array_value #{array_size}"
-                else
-                  "#{callarg}.to_value"
-                end
-        result << "#{retname} = #{value}"
+        value = output_value
+        ["#{retname} = #{value}"]
+      else
+        []
       end
-      result
     end
 
     private
 
+    def output_value
+      if is_caller_allocated_object?
+        callarg
+      elsif needs_outgoing_parameter_conversion?
+        case specialized_type_tag
+        when :enum, :flags
+          "#{argument_class_name}[#{output_conversion_arguments}]"
+        else
+          "#{argument_class_name}.wrap(#{output_conversion_arguments})"
+        end
+      elsif is_fixed_length_array?
+        "#{callarg}.to_sized_array_value #{array_size}"
+      else
+        "#{callarg}.to_value"
+      end
+    end
+
     def is_array_length_parameter?
       @array_arg
     end

data/lib/gir_ffi/base_argument_builder.rb

@@ -68,8 +68,10 @@ module GirFFI
         'GLib::PtrArray'
       when :strv
         'GLib::Strv'
-      when :c, :zero_terminated
+      when :c
         'GirFFI::InPointer'
+      when :zero_terminated
+        'GirFFI::ZeroTerminated'
       else
         TAG_TO_WRAPPER_CLASS_MAP[tag]
       end
@@ -129,9 +131,9 @@ module GirFFI
       case specialized_type_tag
       when :utf8, :void
         "#{self_t}, #{name}"
-      when :glist, :gslist, :ghash, :array
+      when :glist, :gslist, :ghash, :array, :zero_terminated
         "#{elm_t}, #{name}"
-      when :c, :zero_terminated
+      when :c
         "#{type_specification}, #{name}"
       when :callback
         iface = type_info.interface

data/lib/gir_ffi/builder/type/object.rb

@@ -83,6 +83,7 @@ module GirFFI
           @klass.class_eval builder.setter_def
         end
 
+        # TODO: Guard agains accidental invocation of undefined vfuncs.
         def setup_vfunc_invokers
           info.vfuncs.each do |vfinfo|
             invoker = vfinfo.invoker

data/lib/gir_ffi/builder/type/user_defined.rb

@@ -30,10 +30,9 @@ module GirFFI
             type_info.instance_size += FFI.type_size(:int32)
           end
 
-          new_type = GObject.type_register_static parent_type, @klass.name, type_info, 0
+          @gtype = GObject.type_register_static(parent_type, @klass.name,
+                                                type_info, 0)
 
-          # TODO: Check that class ultimately derives from GObject.
-          @gtype = new_type
           @structklass = get_or_define_class @klass, :Struct, layout_superclass
           setup_class unless already_set_up
           CACHE[@gtype] = @klass

data/lib/gir_ffi/builder.rb

@@ -52,8 +52,8 @@ module GirFFI
       types = info.args.map { |arg| iarginfo_to_ffitype arg }
 
       if info.info_type == :function
-	types.unshift :pointer if info.method?
-	types << :pointer if info.throws?
+        types.unshift :pointer if info.method?
+        types << :pointer if info.throws?
       end
 
       types

data/lib/gir_ffi/builder_helper.rb

@@ -2,9 +2,9 @@ module GirFFI
   module BuilderHelper
     def const_defined_for parent, name
       if RUBY_VERSION < "1.9"
-	parent.const_defined? name
+        parent.const_defined? name
       else
-	parent.const_defined? name, false
+        parent.const_defined? name, false
       end
     end
 

data/lib/gir_ffi/callback_helper.rb

@@ -8,13 +8,13 @@ module GirFFI
       return nil if prc.nil?
       info = GObjectIntrospection::IRepository.default.find_by_name namespace, name
       return Callback.new do |*args|
-	prc.call(*map_callback_args(args, info))
+        prc.call(*map_callback_args(args, info))
       end
     end
 
     def self.map_callback_args args, info
       args.zip(info.args).map { |arg, inf|
-	map_single_callback_arg arg, inf.argument_type }
+        map_single_callback_arg arg, inf.argument_type }
     end
 
     # TODO: Use GirFFI::ReturnValue classes for mapping.
@@ -23,18 +23,18 @@ module GirFFI
       when :interface
         map_interface_callback_arg arg, type
       when :utf8
-	ArgHelper.ptr_to_utf8 arg
+        ArgHelper.ptr_to_utf8 arg
       when :void
         map_void_callback_arg arg
       when :array
-	subtype = type.param_type(0)
+        subtype = type.param_type(0)
         if subtype.tag == :interface and arg.is_a?(FFI::Pointer)
-	  map_interface_callback_arg arg, subtype
-	else
-	  raise NotImplementedError
-	end
+          map_interface_callback_arg arg, subtype
+        else
+          raise NotImplementedError
+        end
       else
-	arg
+        arg
       end
     end
 

data/lib/gir_ffi/function_builder.rb

@@ -22,9 +22,9 @@ module GirFFI
       alldata = @data.dup << @rvdata
 
       alldata.each {|data|
-	idx = data.type_info.array_length
+        idx = data.type_info.array_length
         if idx > -1
-          data.length_arg = @data[idx] 
+          data.length_arg = @data[idx]
           @data[idx].array_arg = data
         end
       }

data/lib/gir_ffi/in_out_pointer.rb

@@ -57,15 +57,13 @@ module GirFFI
     private
 
     def adjust_value_in value
-      return nil_value if value.nil?
-
       case @value_type
       when :gboolean
         (value ? 1 : 0)
       when :utf8
         InPointer.from :utf8, value
       else
-        value
+        value || nil_value
       end
     end
 

data/lib/gir_ffi/in_pointer.rb

@@ -10,8 +10,14 @@ module GirFFI
         from_utf8_array ary
       when :interface_pointer
         from_interface_pointer_array ary
-      else
+      when Symbol
         from_basic_type_array type, ary
+      when FFI::Enum
+        from_enum_array type, ary
+      when Array
+        from_interface_pointer_array ary
+      else
+        raise NotImplementedError, type
       end
     end
 
@@ -49,6 +55,10 @@ module GirFFI
         self.from_array :pointer, ptr_ary
       end
 
+      def from_enum_array type, ary
+        self.from_array :int32, ary.map {|sym| type.to_native sym, nil }
+      end
+
       def from_utf8 str
         len = str.bytesize
         ptr = AllocationHelper.safe_malloc(len + 1).write_string(str).put_char(len, 0)
@@ -57,8 +67,11 @@ module GirFFI
 
       def from_basic_type_array type, ary
         ffi_type = TypeMap.map_basic_type type
-        block = ArgHelper.allocate_array_of_type ffi_type, ary.length
+        block = ArgHelper.allocate_array_of_type ffi_type, ary.length + 1
         block.send "put_array_of_#{ffi_type}", 0, ary
+        block.send("put_#{ffi_type}",
+                   ary.length * FFI.type_size(ffi_type),
+                   (ffi_type == :pointer ? nil : 0))
 
         self.new block
       end

data/lib/gir_ffi/info_ext/i_arg_info.rb

@@ -0,0 +1,27 @@
+module GirFFI
+  module InfoExt
+    # Extensions for GObjectIntrospection::IArgInfo needed by GirFFI
+    module IArgInfo
+      def cast_signal_argument arg
+        arg_t = self.argument_type
+        if arg_t.tag == :interface
+          iface = arg_t.interface
+          kls = GirFFI::Builder.build_class iface
+          case iface.info_type
+          when :enum, :flags
+            kls[arg]
+          when :interface
+            arg.to_object
+          else
+            kls.wrap(arg)
+          end
+        else
+          arg
+        end
+      end
+    end
+  end
+end
+
+GObjectIntrospection::IArgInfo.send :include, GirFFI::InfoExt::IArgInfo
+

data/lib/gir_ffi/info_ext/i_field_info.rb

@@ -1,5 +1,6 @@
 module GirFFI
   module InfoExt
+    # Extensions for GObjectIntrospection::IFieldInfo needed by GirFFI
     module IFieldInfo
       def layout_specification
         [ name.to_sym,

data/lib/gir_ffi/info_ext/i_property_info.rb

@@ -1,5 +1,6 @@
 module GirFFI
   module InfoExt
+    # Extensions for GObjectIntrospection::IPropertyInfo needed by GirFFI
     module IPropertyInfo
       def getter_name
         name.gsub(/-/, '_')

data/lib/gir_ffi/info_ext/i_registered_type_info.rb

@@ -4,7 +4,7 @@ module GirFFI
   module InfoExt
     module IRegisteredTypeInfo
       def full_type_name
-	"::#{safe_namespace}::#{name}"
+        "::#{safe_namespace}::#{name}"
       end
     end
   end

data/lib/gir_ffi/info_ext/i_signal_info.rb

@@ -0,0 +1,65 @@
+module GirFFI
+  module InfoExt
+    # Extensions for GObjectIntrospection::ISignalInfo needed by GirFFI
+    module ISignalInfo
+      # Create a signal hander callback. Wraps the given block in such a way that
+      # arguments and return value are cast correctly to the ruby world and back.
+      #
+      # @param  block   The body of the signal handler
+      #
+      # @return [FFI::Function] The signal handler, ready to be passed as a
+      #   callback to C.
+      def signal_callback &block
+        GirFFI::Builder.build_callback self, &signal_callback_args(&block)
+      end
+
+      # TODO: Generate cast back methods using existing Argument builders.
+      def cast_back_signal_arguments *arguments
+        instance = GirFFI::ArgHelper.object_pointer_to_object arguments.shift
+        user_data = GirFFI::ArgHelper::OBJECT_STORE[arguments.pop.address]
+
+        extra_arguments = self.args.zip(arguments).map do |info, arg|
+          info.cast_signal_argument(arg)
+        end
+
+        return [instance, *extra_arguments].push user_data
+      end
+
+      def signal_callback_args &block
+        raise ArgumentError, "Block needed" unless block
+        return Proc.new do |*args|
+          mapped = cast_back_signal_arguments(*args)
+          block.call(*mapped)
+        end
+      end
+
+      def signal_arguments_to_gvalue_array instance, *rest
+        arr = ::GObject::ValueArray.new self.n_args + 1
+
+        arr.append signal_reciever_to_gvalue instance
+
+        self.args.zip(rest).each do |info, arg|
+          arr.append info.argument_type.make_g_value.set_value(arg)
+        end
+
+        arr
+      end
+
+      def gvalue_for_signal_return_value
+        GObject::Value.for_g_type return_type.g_type
+      end
+
+      private
+
+      def signal_reciever_to_gvalue instance
+        val = ::GObject::Value.new
+        val.init ::GObject.type_from_instance instance
+        val.set_instance instance
+        return val
+      end
+
+    end
+  end
+end
+
+GObjectIntrospection::ISignalInfo.send :include, GirFFI::InfoExt::ISignalInfo

data/lib/gir_ffi/info_ext/i_type_info.rb

@@ -2,9 +2,24 @@ require 'gir_ffi/builder_helper'
 
 module GirFFI
   module InfoExt
+    # Extensions for GObjectIntrospection::IArgInfo needed by GirFFI
     module ITypeInfo
       include BuilderHelper
 
+      def g_type
+        tag = self.tag
+        case tag
+        when :interface
+          interface.g_type
+        else
+          GObject::TYPE_TAG_TO_GTYPE[tag]
+        end
+      end
+
+      def make_g_value
+        GObject::Value.for_g_type g_type
+      end
+
       def layout_specification_type
         ffitype = GirFFI::Builder.itypeinfo_to_ffitype self
         case ffitype

data/lib/gir_ffi/info_ext/safe_constant_name.rb

@@ -1,5 +1,6 @@
 module GirFFI
   module InfoExt
+    # Extension module provinding a #safe_name method suitable for types.
     module SafeConstantName
       def safe_name
         name.gsub(/^./) do |char|

data/lib/gir_ffi/info_ext/safe_function_name.rb

@@ -1,5 +1,6 @@
 module GirFFI
   module InfoExt
+    # Extension module provinding a #safe_name method suitable for functions.
     module SafeFunctionName
       def safe_name
         name = self.name

data/lib/gir_ffi/info_ext.rb

@@ -1,6 +1,8 @@
 require 'gir_ffi/info_ext/safe_constant_name'
 require 'gir_ffi/info_ext/safe_function_name'
+require 'gir_ffi/info_ext/i_arg_info'
 require 'gir_ffi/info_ext/i_field_info'
 require 'gir_ffi/info_ext/i_property_info'
+require 'gir_ffi/info_ext/i_signal_info'
 require 'gir_ffi/info_ext/i_registered_type_info'
 require 'gir_ffi/info_ext/i_type_info'