gir_ffi 0.2.2 → 0.2.3

data/History.txt

@@ -1,3 +1,9 @@
+== 0.2.3 / 2011-12-31
+
+* Fix issue #7: methods that take GValues will autoconvert other values.
+* Fix method lookup when include'ing a module that is an Interface.
+* Various refactorings.
+
 == 0.2.2 / 2011-12-07
 
 * Fix issue #19: Check if a GLib::PtrArray.add method was generated

data/lib/ffi-glib.rb

@@ -6,6 +6,7 @@ require 'ffi-glib/hash_table'
 require 'ffi-glib/byte_array'
 require 'ffi-glib/array'
 require 'ffi-glib/ptr_array'
+require 'ffi-glib/strv'
 
 module GLib
   load_class :HFunc

data/lib/ffi-glib/array.rb

@@ -6,14 +6,17 @@ module GLib
   class Array
     include Enumerable
 
-    attr_accessor :element_type
+    attr_reader :element_type
+    def element_type= val
+      @element_type = val
+      check_element_size_match
+    end
 
     class << self
       undef :new
       def new type
-        ffi_type = GirFFI::TypeMap.map_basic_type_or_string(type)
-        wrap(Lib.g_array_new(0, 0, FFI.type_size(ffi_type))).tap {|it|
-          it.element_type = type}
+        ptr = Lib.g_array_new(0, 0, calculated_element_size(type))
+        wrap type, ptr
       end
     end
 
@@ -24,16 +27,52 @@ module GLib
       self
     end
 
-    # FIXME: Make GirFII::InPointer support #each and use that.
-    def each &block
-      to_typed_array.each(&block)
+    # Re-implementation of the g_array_index macro
+    def index idx
+      ptr = @struct[:data].get_pointer(idx * get_element_size)
+      GirFFI::ArgHelper.cast_from_pointer(element_type, ptr)
+    end
+
+    def each
+      @struct[:len].times.each do |idx|
+        yield index(idx)
+      end
+    end
+
+    def get_element_size
+      self.class.get_element_size self
+    end
+
+    def self.wrap elmttype, ptr
+      super(ptr).tap do |it|
+        break if it.nil?
+        it.element_type = elmttype
+      end
+    end
+
+    def self.from elmtype, it
+      case it
+      when self then it
+      when FFI::Pointer then wrap elmtype, it
+      else self.new(elmtype).tap {|arr| arr.append_vals it }
+      end
     end
 
     private
 
-    def to_typed_array
-      GirFFI::ArgHelper.ptr_to_typed_array(self.element_type,
-                                           @struct[:data], @struct[:len])
+    def self.calculated_element_size type
+      ffi_type = GirFFI::TypeMap.map_basic_type_or_string(type)
+      FFI.type_size(ffi_type)
+    end
+
+    def calculated_element_size
+      self.class.calculated_element_size self.element_type
+    end
+
+    def check_element_size_match
+      unless calculated_element_size == self.get_element_size
+        raise "Element sizes do not match"
+      end
     end
   end
 end

data/lib/ffi-glib/hash_table.rb

@@ -37,26 +37,40 @@ module GLib
                          else
                            [nil, nil]
                          end
-        wrap(keytype, valtype, Lib.g_hash_table_new(hash_fn, eq_fn))
+        wrap [keytype, valtype], Lib.g_hash_table_new(hash_fn, eq_fn)
       end
 
-      def wrap keytype, valtype, ptr
+      def wrap types, ptr
         super(ptr).tap do |it|
-          break if it.nil?
+          return nil if it.nil?
+          keytype, valtype = *types
           it.key_type = keytype
           it.value_type = valtype
         end
       end
 
-      def from_hash keytype, valtype, hash
+      def from_hash types, hash
+        keytype, valtype = *types
         return nil if hash.nil?
-        return hash if hash.is_a? self
+        if hash.is_a? self
+          hash.key_type = keytype
+          hash.value_type = valtype
+          return hash
+        end
         ghash = self.new keytype, valtype
         hash.each do |key, val|
           ghash.insert key, val
         end
         ghash
       end
+
+      def from types, it
+        if it.is_a? FFI::Pointer
+          wrap types, it
+        else
+          from_hash types, it
+        end
+      end
     end
   end
 end

data/lib/ffi-glib/list.rb

@@ -23,7 +23,10 @@ module GLib
 
       def from_array type, arr
         return nil if arr.nil?
-        return arr if arr.is_a? self
+        if arr.is_a? self
+          arr.element_type = type
+          return arr
+        end
         arr.inject(self.new type) { |lst, val|
           lst.append val }
       end

data/lib/ffi-glib/list_methods.rb

@@ -32,8 +32,15 @@ module GLib
           it.element_type = elmttype
         end
       end
+
+      def from elmttype, it
+        if it.is_a? FFI::Pointer
+          wrap elmttype, it
+        else
+          from_array elmttype, it
+        end
+      end
     end
   end
 end
 
-

data/lib/ffi-glib/s_list.rb

@@ -23,7 +23,10 @@ module GLib
 
       def from_array type, arr
         return nil if arr.nil?
-        return arr if arr.is_a? self
+        if arr.is_a? self
+          arr.element_type = type
+          return arr
+        end
         arr.reverse.inject(self.new type) { |lst, val|
           lst.prepend val }
       end

data/lib/ffi-glib/strv.rb

@@ -0,0 +1,31 @@
+module GLib
+  # Represents a null-terminated array of strings.
+  class Strv
+    include Enumerable
+
+    POINTER_SIZE = FFI.type_size(:pointer)
+
+    def initialize ptr
+      @ptr = ptr
+    end
+
+    def to_ptr
+      @ptr
+    end
+
+    def each
+      return if @ptr.null?
+      offset = 0
+      loop do
+        ptr = @ptr.get_pointer offset
+        break if ptr.null?
+        yield ptr.read_string
+        offset += POINTER_SIZE
+      end
+    end
+
+    def self.wrap ptr
+      self.new ptr
+    end
+  end
+end

data/lib/ffi-gobject.rb

@@ -1,5 +1,7 @@
 GirFFI.setup :GObject
 
+require 'ffi-gobject/base'
+
 require 'ffi-gobject/value'
 require 'ffi-gobject/initially_unowned'
 require 'ffi-gobject/closure'
@@ -83,39 +85,4 @@ module GObject
       [:pointer, ClosureMarshal], :void
   end
 
-  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_HASH_TABLE = type_from_name("GHashTable")
-
-  TYPE_TAG_TO_GTYPE = {
-    :void => TYPE_NONE,
-    :gboolean => TYPE_BOOLEAN,
-    :gint32 => TYPE_INT,
-    :gfloat => TYPE_FLOAT,
-    :gdouble => TYPE_DOUBLE,
-    :utf8 => TYPE_STRING,
-    :ghash => TYPE_HASH_TABLE,
-    :glist => TYPE_POINTER
-  }
 end

data/lib/ffi-gobject/base.rb

@@ -0,0 +1,38 @@
+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_STRV = GLib.strv_get_type
+  TYPE_HASH_TABLE = type_from_name("GHashTable")
+
+  TYPE_TAG_TO_GTYPE = {
+    :void => TYPE_NONE,
+    :gboolean => TYPE_BOOLEAN,
+    :gint32 => TYPE_INT,
+    :gfloat => TYPE_FLOAT,
+    :gdouble => TYPE_DOUBLE,
+    :utf8 => TYPE_STRING,
+    :ghash => TYPE_HASH_TABLE,
+    :glist => TYPE_POINTER
+  }
+end

data/lib/ffi-gobject/object.rb

@@ -7,41 +7,21 @@ module GObject
     _setup_instance_method "set_property"
 
     def get_property_with_override property_name
-      prop = self.class._find_property property_name
-      type = prop.property_type
-      v = Helper.gvalue_for_type_info type
-      get_property_without_override property_name, v
+      type = get_property_type property_name
+      gvalue = Helper.gvalue_for_type_info type
 
-      val = v.ruby_value
-      case type.tag
-      when :ghash
-        GLib::HashTable.wrap type.param_type(0).tag, type.param_type(1).tag,
-          val.to_ptr
-      when :glist
-        GLib::List.wrap type.param_type(0).tag, val
-      else
-        val
-      end
+      get_property_without_override property_name, gvalue
+
+      adjust_value_to_type gvalue.ruby_value, type
     end
 
     def set_property_with_override property_name, value
-      prop = self.class._find_property property_name
-      type = prop.property_type
-      v = Helper.gvalue_for_type_info type
+      type = get_property_type property_name
+      gvalue = Helper.gvalue_for_type_info type
 
-      case type.tag
-      when :glist
-        lst = GLib::List.from_array type.param_type(0).tag, value
-        v.set_value lst.to_ptr
-      when :ghash
-        hsh = GLib::HashTable.from_hash type.param_type(0).tag,
-          type.param_type(1).tag, value
-        v.set_value hsh.to_ptr
-      else
-        v.set_value value
-      end
+      gvalue.set_value adjust_value_to_type(value, type)
 
-      set_property_without_override property_name, v
+      set_property_without_override property_name, gvalue
     end
 
     alias get_property_without_override get_property
@@ -49,6 +29,24 @@ module GObject
 
     alias set_property_without_override set_property
     alias set_property set_property_with_override
+
+    private
+
+    def get_property_type property_name
+      prop = self.class._find_property property_name
+      prop.property_type
+    end
+
+    def adjust_value_to_type val, type
+      case type.tag
+      when :ghash
+        GLib::HashTable.from [type.param_type(0).tag, type.param_type(1).tag],
+          val
+      when :glist
+        GLib::List.from type.param_type(0).tag, val
+      else
+        val
+      end
+    end
   end
 end
-

data/lib/ffi-gobject/value.rb

@@ -11,40 +11,39 @@ module GObject
       set_value val
     end
 
+    TYPE_TO_SET_METHOD_MAP = {
+      TYPE_BOOLEAN => :set_boolean,
+      TYPE_INT => :set_int,
+      TYPE_STRING => :set_string,
+      TYPE_FLOAT => :set_float,
+      TYPE_DOUBLE => :set_double,
+      TYPE_OBJECT => :set_instance,
+      TYPE_BOXED => :set_boxed,
+      TYPE_POINTER => :set_pointer,
+      TYPE_ENUM => :set_enum
+    }
+
     def set_value val
-      case current_fundamental_type
-      when TYPE_BOOLEAN
-        set_boolean val
-      when TYPE_INT
-        set_int val
-      when TYPE_STRING
-        set_string val
-      when TYPE_FLOAT
-        set_float val
-      when TYPE_DOUBLE
-        set_double val
-      when TYPE_BOXED
-        set_boxed val
-      when TYPE_OBJECT
-        set_instance val
-      when TYPE_POINTER
-        set_pointer val
-      when TYPE_ENUM
-        set_enum val
-      else
-        raise "Don't know how to handle #{current_gtype_name}"
-      end
+      method = TYPE_TO_SET_METHOD_MAP[current_fundamental_type]
+      call_or_raise method, val
       self
     end
 
+    CLASS_TO_GTYPE_MAP = {
+      true => TYPE_BOOLEAN,
+      false => TYPE_BOOLEAN,
+      Integer => TYPE_INT,
+      String => TYPE_STRING
+    }
+
     def init_for_ruby_value val
-      case val
-      when true, false
-        init TYPE_BOOLEAN
-      when Integer
-        init TYPE_INT
+      CLASS_TO_GTYPE_MAP.each do |klass, type|
+        if klass === val
+          init type
+          return self
+        end
       end
-      self
+      raise "Can't handle #{val.class}"
     end
 
     def current_gtype
@@ -59,41 +58,58 @@ module GObject
       GObject.type_name current_gtype
     end
 
+    TYPE_TO_GET_METHOD_MAP = {
+      TYPE_BOOLEAN => :get_boolean,
+      TYPE_INT => :get_int,
+      TYPE_STRING => :get_string,
+      TYPE_FLOAT => :get_float,
+      TYPE_DOUBLE => :get_double,
+      TYPE_OBJECT => :get_object,
+      TYPE_BOXED => :get_boxed_enhanced,
+      TYPE_POINTER => :get_pointer
+    }
+
     def ruby_value
-      case current_fundamental_type
-      when TYPE_BOOLEAN
-        get_boolean
-      when TYPE_INT
-        get_int
-      when TYPE_STRING
-        get_string
-      when TYPE_FLOAT
-        get_float
-      when TYPE_DOUBLE
-        get_double
-      when TYPE_OBJECT
-        get_object
-      when TYPE_BOXED
-        boxed = get_boxed
-        case current_gtype_name.to_sym
-        when :GStrv
-          # FIXME: Extract this method to even lower level module.
-          GirFFI::ArgHelper.strv_to_utf8_array boxed
-        when :GHashTable
-          GLib::HashTable.wrap :gpointer, :gpointer, boxed
+      method = TYPE_TO_GET_METHOD_MAP[current_fundamental_type]
+      call_or_raise method
+    end
+
+    class << self
+      def wrap_ruby_value val
+        self.new.set_ruby_value val
+      end
+
+      def from val
+        case val
+        when self
+          val
+        when nil
+          nil
         else
-          GirFFI::ArgHelper.wrap_object_pointer_by_gtype boxed, current_gtype
+          wrap_ruby_value val
         end
-      when TYPE_POINTER
-        get_pointer
+      end
+    end
+
+    private
+
+    def get_boxed_enhanced
+      boxed = get_boxed
+      case current_gtype
+      when TYPE_STRV
+        GLib::Strv.wrap boxed
+      when TYPE_HASH_TABLE
+        GLib::HashTable.wrap [:gpointer, :gpointer], boxed
       else
-        raise "Don't know how to handle #{current_gtype_name}"
+        GirFFI::ArgHelper.wrap_object_pointer_by_gtype boxed, current_gtype
       end
     end
 
-    class << self
-      def wrap_ruby_value val
-        self.new.set_ruby_value val
+    def call_or_raise method, *args
+      if method
+        send method, *args
+      else
+        raise "Don't know how to handle #{current_gtype_name}"
       end
     end
   end