gir_ffi 0.6.6 → 0.6.7

data/History.txt

@@ -1,3 +1,17 @@
+== 0.6.7 / 2013-09-28
+
+* Uniform handling of callback, signal and method arguments
+* Automatically convert array elements to GValue
+* Support inline array fields
+* Support struct fields
+* Improved field setters and getters
+* Support many more types of properties
+* Support skipped arguments and return values
+* Fix refcount for the result of IBaseInfo#container
+* Check bounds in GLib::PtrArray#index and GLib::Array#index
+* Deprecate several methods
+* Lots of refactoring
+
 == 0.6.6 / 2013-08-05
 
 * Handle GArrays of booleans and structs

data/TODO.rdoc

@@ -8,17 +8,35 @@ reference count of any objects it gets from GObject. This task therefore involve
 - Free non-GObject pointers as needed (at garbage-collection time)
 - Lower reference count of GObjects (at garbage-collection time)
 
+== Refactorings
+
+These in the order they occured to me, and may therefore be fixed in any order.
+
+- Create Type objects for all FFI types, including the ones currently
+  represented by a single symbol, so we can always do stuff like
+
+    GirFFI::Types::UInt8.get_value_from_pointer(ptr)
+
+  rather than having awkward dynamic method dispatch inside GirFFI::InOutPointer.
+
+- Move code in GirFFI::Struct to StructBase, then somehow unify UnionBase and
+  StructBase.
+
+- Move to a single Pointer class, rather than InPointer, InOutPointer and
+  Pointer monkeypatching.
+
+- Move special types like SizedArray to sane namespaces. Types (like
+  GLib::List) that have actual GLib implementations go to the GLib namespace.
+  Other types go to the GirFFI namespace.
+
+- Use argumentbuilders to build signal argument marshalling functions.
+
 == Persistent Ruby GObject identity
 
 GirFFI should make sure that if it gets a pointer to a GObject for which a Ruby
 object already exists, the existing object is returned. This involves the use
 of WeakRef, no doubt.
 
-== Remove code for passing generic pointers
-
-Generic pointers have been declared 'not introspectable', so
-handling them can be removed.
-
 == Handle fundamental objects that are not GObject.
 
 This is a big one. See commit 1e9822c7817062a9b853269b9418fd78782090b5 in

data/lib/ffi-glib/array.rb

@@ -22,27 +22,21 @@ module GLib
 
     def append_vals ary
       bytes = GirFFI::InPointer.from_array element_type, ary
-      len = ary.length
-      Lib.g_array_append_vals(self, bytes, len)
+      Lib.g_array_append_vals(self, bytes, ary.length)
       self
     end
 
     # Re-implementation of the g_array_index macro
     def index idx
-      # TODO: Check idx < length
-      ptr = GirFFI::InOutPointer.new element_type, data + idx * get_element_size
-      case element_type
-      when :utf8
-        GirFFI::ArgHelper.ptr_to_utf8 ptr.to_value
-      when Symbol
-        ptr.to_value
-      else
-        element_type.wrap ptr.to_value
+      if idx >= length or idx < 0
+        raise IndexError, "Index #{idx} outside of bounds 0..#{length - 1}"
       end
+      ptr = GirFFI::InOutPointer.new element_type, data_ptr + idx * get_element_size
+      ptr.to_ruby_value
     end
 
     def each
-      length.times.each do |idx|
+      length.times do |idx|
         yield index(idx)
       end
     end
@@ -51,10 +45,16 @@ module GLib
       @struct[:len]
     end
 
-    def data
+    def data_ptr
       @struct[:data]
     end
 
+    undef :data
+
+    # @deprecated From 0.7.0, data will return the actual data as a string,
+    # as generated by GirFFI.
+    alias data data_ptr
+
     def get_element_size
       Lib.g_array_get_element_size self
     end
@@ -81,8 +81,7 @@ module GLib
 
     def self.calculated_element_size type
       ffi_type = GirFFI::TypeMap.type_specification_to_ffitype(type)
-      # FIXME: Smell. Make struct ffi_types into DataConvertor?
-      FFI.type_size(ffi_type) rescue ffi_type.size
+      FFI.type_size(ffi_type)
     end
 
     def calculated_element_size

data/lib/ffi-glib/container_class_methods.rb

@@ -13,7 +13,6 @@ module GLib
       when FFI::Pointer
         wrap typespec, it
       when self
-        # TODO: Reset or check?
         it.reset_typespec typespec
       else
         from_enumerable typespec, it

data/lib/ffi-glib/hash_table.rb

@@ -8,9 +8,8 @@ module GLib
     include Enumerable
     extend ContainerClassMethods
 
-    # TODO: Restructure so these can become attr_readers.
-    attr_accessor :key_type
-    attr_accessor :value_type
+    attr_reader :key_type
+    attr_reader :value_type
 
     def each
       prc = Proc.new {|keyptr, valptr, userdata|
@@ -41,7 +40,7 @@ module GLib
     end
 
     def reset_typespec typespec
-      self.key_type, self.value_type = *typespec
+      @key_type, @value_type = *typespec
       self
     end
 

data/lib/ffi-glib/ptr_array.rb

@@ -8,6 +8,8 @@ module GLib
 
     attr_accessor :element_type
 
+    POINTER_SIZE = FFI.type_size(:pointer)
+
     class << self
       remove_method :new
       # Remove stub generated by builder.
@@ -46,17 +48,23 @@ module GLib
 
     # Re-implementation of the g_ptr_array_index macro
     def index idx
-      sz = FFI.type_size :pointer
-      ptr = @struct[:pdata].get_pointer(idx * sz)
-      GirFFI::ArgHelper.cast_from_pointer(element_type, ptr)
+      if idx >= length or idx < 0
+        raise IndexError, "Index #{idx} outside of bounds 0..#{length - 1}"
+      end
+      ptr = GirFFI::InOutPointer.new element_type, @struct[:pdata] + idx * POINTER_SIZE
+      ptr.to_ruby_value
     end
 
     def each
-      @struct[:len].times.each do |idx|
+      length.times do |idx|
         yield index(idx)
       end
     end
 
+    def length
+      @struct[:len]
+    end
+
     def ==(other)
       self.to_a == other.to_a
     end

data/lib/ffi-glib/sized_array.rb

@@ -1,3 +1,4 @@
+# FIXME: SizedArray does not really belong in GLib, does it?
 module GLib
   # Class representing an array with a determined size
   class SizedArray
@@ -14,14 +15,14 @@ module GLib
       @pointer
     end
 
+    def index idx
+      ptr = GirFFI::InOutPointer.new element_type, @pointer + idx * element_size
+      ptr.to_ruby_value
+    end
+
     def each &block
-      # TODO: Move implementation from GirFFI::ArgHelper to here.
-      # While doing so, the implentation could also become a real iterator
-      arr = GirFFI::ArgHelper.ptr_to_typed_array(@element_type, @pointer, @size)
-      if block_given?
-        arr.each(&block)
-      else
-        arr.each
+      size.times do |idx|
+        yield index(idx)
       end
     end
 
@@ -29,6 +30,25 @@ module GLib
       self.to_a == other.to_a
     end
 
+    def size_in_bytes
+      size * element_size
+    end
+
+    def self.copy_value_to_pointer value, pointer
+      size = value.size_in_bytes
+      pointer.put_bytes(0, value.to_ptr.read_bytes(size), 0, size)
+    end
+
+    private
+
+    def element_ffi_type
+      @element_ffi_type ||= GirFFI::TypeMap.type_specification_to_ffitype element_type
+    end
+
+    def element_size
+      @element_size ||= FFI.type_size element_ffi_type
+    end
+
     def self.wrap element_type, size, pointer
       new element_type, size, pointer unless pointer.null?
     end

data/lib/ffi-gobject.rb

@@ -10,13 +10,9 @@ require 'ffi-gobject/initially_unowned'
 require 'ffi-gobject/closure'
 require 'ffi-gobject/object'
 require 'ffi-gobject/ruby_closure'
-require 'gir_ffi/builder/type/user_defined'
+require 'gir_ffi/builders/user_defined_builder'
 
 module GObject
-  def self.type_init
-    Lib::g_type_init
-  end
-
   def self.object_ref obj
     Lib::g_object_ref obj.to_ptr
   end
@@ -76,9 +72,9 @@ module GObject
     signal, _ = detailed_signal.split('::')
     sig_info = object.class.find_signal signal
     callback = sig_info.signal_callback(&block)
-    GirFFI::CallbackHelper.store_callback callback
+    GirFFI::CallbackBase.store_callback callback
 
-    data_ptr = GirFFI::ArgHelper.object_to_inptr data
+    data_ptr = GirFFI::InPointer.from_object data
 
     Lib.g_signal_connect_data object, detailed_signal, callback, data_ptr, nil, 0
   end
@@ -105,12 +101,13 @@ module GObject
     attach_function :g_object_unref, [:pointer], :void
     attach_function :g_object_is_floating, [:pointer], :bool
 
-    attach_function :g_strv_get_type, [], :size_t
+    attach_function :g_array_get_type, [], :size_t
     attach_function :g_hash_table_get_type, [], :size_t
+    attach_function :g_strv_get_type, [], :size_t
 
     attach_function :g_signal_connect_data,
       [:pointer, :string, Callback, :pointer, ClosureNotify, ConnectFlags],
-        :ulong
+      :ulong
     attach_function :g_closure_set_marshal,
       [:pointer, ClosureMarshal], :void
 
@@ -119,17 +116,19 @@ module GObject
       :pointer
   end
 
-  TYPE_STRV = Lib.g_strv_get_type
+  TYPE_ARRAY = Lib.g_array_get_type
   TYPE_HASH_TABLE = Lib.g_hash_table_get_type
+  TYPE_STRV = Lib.g_strv_get_type
 
   TYPE_TAG_TO_GTYPE = {
-    :void => TYPE_NONE,
+    :array => TYPE_ARRAY,
     :gboolean => TYPE_BOOLEAN,
-    :gint32 => TYPE_INT,
-    :gfloat => TYPE_FLOAT,
     :gdouble => TYPE_DOUBLE,
-    :utf8 => TYPE_STRING,
+    :gfloat => TYPE_FLOAT,
     :ghash => TYPE_HASH_TABLE,
-    :glist => TYPE_POINTER
+    :gint32 => TYPE_INT,
+    :glist => TYPE_POINTER,
+    :utf8 => TYPE_STRING,
+    :void => TYPE_NONE
   }
 end

data/lib/ffi-gobject/closure.rb

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

data/lib/ffi-gobject/object.rb

@@ -1,35 +1,57 @@
-require 'ffi-gobject/ruby_style'
-
 module GObject
   load_class :Object
 
   # Overrides for GObject, GObject's generic base class.
   class Object
 
-    include RubyStyle
-
     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)
+      end
+      super
+    end
+
+    def signal_connect(event, &block)
+      GObject.signal_connect(self, event, &block)
+    end
+
     setup_instance_method "get_property"
     setup_instance_method "set_property"
 
     def get_property_with_override property_name
-      type = get_property_type property_name
-      gvalue = type.make_g_value
+      type_info = get_property_type property_name
+      pspec = type_class.find_property property_name
 
+      gvalue = GObject::Value.for_g_type pspec.value_type
       get_property_without_override property_name, gvalue
 
-      adjust_value_to_type gvalue.get_value, type
+      case type_info.tag
+      when :ghash, :glist
+        adjust_value_to_type gvalue.get_value_plain, type_info
+      else
+        gvalue.get_value
+      end
     end
 
     def set_property_with_override property_name, value
-      type = get_property_type property_name
-      gvalue = type.make_g_value
-
-      gvalue.set_value adjust_value_to_type(value, type)
+      type_info = get_property_type property_name
+      pspec = type_class.find_property property_name
 
+      gvalue = GObject::Value.for_g_type pspec.value_type
+      gvalue.set_value adjust_value_to_type(value, type_info)
       set_property_without_override property_name, gvalue
     end
 
+    def type_class
+      GObject::ObjectClass.wrap(self.to_ptr.get_pointer 0)
+    end
+
     alias get_property_without_override get_property
     alias get_property get_property_with_override
 
@@ -43,12 +65,15 @@ module GObject
       prop.property_type
     end
 
-    def adjust_value_to_type val, type
-      case type.tag
+    # TODO: Move to ITypeInfo
+    def adjust_value_to_type val, type_info
+      case type_info.flattened_tag
       when :ghash
-        GLib::HashTable.from type.element_type, val
+        GLib::HashTable.from type_info.element_type, val
       when :glist
-        GLib::List.from type.element_type, val
+        GLib::List.from type_info.element_type, val
+      when :strv
+        GLib::Strv.from val
       else
         val
       end

data/lib/ffi-gobject/ruby_closure.rb

@@ -37,7 +37,6 @@ module GObject
       return closure
     end
 
-    # TODO: Use invocation_hint and marshal_data
     def self.marshaller(closure, return_value, n_param_values,
                         param_values, _invocation_hint, _marshal_data)
       rclosure = wrap(closure.to_ptr)

data/lib/ffi-gobject/value.rb

@@ -14,16 +14,24 @@ module GObject
 
     TYPE_TO_SET_METHOD_MAP = {
       TYPE_BOOLEAN => :set_boolean,
-      TYPE_INT => :set_int,
-      TYPE_INT64 => :set_int64,
-      TYPE_STRING => :set_string,
-      TYPE_FLOAT => :set_float,
+      TYPE_BOXED => :set_boxed,
+      TYPE_CHAR => :set_char,
       TYPE_DOUBLE => :set_double,
-      TYPE_PARAM => :set_param,
+      TYPE_ENUM => :set_enum,
+      TYPE_FLOAT => :set_float,
+      TYPE_GTYPE => :set_gtype,
+      TYPE_INT64 => :set_int64,
+      TYPE_INT => :set_int,
+      TYPE_LONG => :set_long,
       TYPE_OBJECT => :set_instance_enhanced,
-      TYPE_BOXED => :set_boxed,
+      TYPE_PARAM => :set_param,
       TYPE_POINTER => :set_pointer,
-      TYPE_ENUM => :set_enum
+      TYPE_STRING => :set_string,
+      TYPE_UCHAR => :set_uchar,
+      TYPE_UINT => :set_uint,
+      TYPE_UINT64 => :set_uint64,
+      TYPE_ULONG => :set_ulong,
+      TYPE_VARIANT => :set_variant,
     }
 
     def value= val
@@ -66,17 +74,34 @@ module GObject
 
     TYPE_TO_GET_METHOD_MAP = {
       TYPE_BOOLEAN => :get_boolean,
-      TYPE_INT => :get_int,
-      TYPE_INT64 => :get_int64,
-      TYPE_STRING => :get_string,
-      TYPE_FLOAT => :get_float,
+      TYPE_BOXED => :get_boxed,
+      TYPE_CHAR => :get_char,
       TYPE_DOUBLE => :get_double,
+      TYPE_FLOAT => :get_float,
+      TYPE_GTYPE => :get_gtype,
+      TYPE_INT64 => :get_int64,
+      TYPE_INT => :get_int,
+      TYPE_LONG => :get_long,
       TYPE_OBJECT => :get_object,
-      TYPE_BOXED => :get_boxed_enhanced,
-      TYPE_POINTER => :get_pointer
+      TYPE_POINTER => :get_pointer,
+      TYPE_STRING => :get_string,
+      TYPE_UCHAR => :get_uchar,
+      TYPE_UINT => :get_uint,
+      TYPE_UINT64 => :get_uint64,
+      TYPE_ULONG => :get_ulong,
+      TYPE_VARIANT => :get_variant,
     }
 
     def get_value
+      value = get_value_plain
+      if current_fundamental_type == TYPE_BOXED
+        wrap_boxed value
+      else
+        value
+      end
+    end
+
+    def get_value_plain
       send get_method
     end
 
@@ -129,27 +154,26 @@ module GObject
       end
     end
 
-    def get_boxed_enhanced
-      boxed = get_boxed
-      gtype = current_gtype
-
-      case gtype
+    def wrap_boxed boxed
+      case current_gtype
       when TYPE_STRV
         GLib::Strv.wrap boxed
       when TYPE_HASH_TABLE
         GLib::HashTable.wrap [:gpointer, :gpointer], boxed
       else
-        GirFFI::ArgHelper.wrap_object_pointer_by_gtype boxed, gtype
+        boxed.wrap_by_gtype current_gtype
       end
     end
 
     def get_method
-      TYPE_TO_GET_METHOD_MAP[current_fundamental_type] or
+      TYPE_TO_GET_METHOD_MAP[current_gtype] or
+        TYPE_TO_GET_METHOD_MAP[current_fundamental_type] or
         raise "Can't find method to get #{current_gtype_name}"
     end
 
     def set_method
-      TYPE_TO_SET_METHOD_MAP[current_fundamental_type] or
+      TYPE_TO_SET_METHOD_MAP[current_gtype] or
+        TYPE_TO_SET_METHOD_MAP[current_fundamental_type] or
         raise "Can't find method to set #{current_gtype_name}"
     end
   end