gir_ffi 0.0.6 → 0.0.7

data/History.txt

@@ -1,3 +1,15 @@
+== 0.0.7 / 2011-04-01
+
+* Support gobject-introspection 0.10, drop support for earlier versions.
+  - Use Regress, not Everything, for testing.
+  - Deal with functions that are no longer introspectable.
+* Correctly handle constructors that declare their return type different
+  from their class.
+* Implement RubyClosure, a GObject::Closure for handling ruby callbacks.
+* Handle GLib's singly and doubly linked lists.
+* Handle callback types defined in-place (like Closure's marshal).
+* Refactoring.
+
 == 0.0.6 / 2011-03-01
 
 * Cast returned GObjects to their actual type.

data/TODO.rdoc

@@ -25,6 +25,16 @@ overrides will have to be used for the cases where the 'gpointer' actually
 needs to be a GObject. I consider it an omission in GIRepository that these
 two cases are not distinguished.
 
+Update: generic pointers have been declared 'not introspectable', so
+handling them can be removed.
+
+== Check binding of GObject:
+
+(11:37:03 PM) walters: the basic story is that GObject should be manually bound
+(11:47:02 PM) ebassi: the really necessary bits are: GObject/GInitiallyUnowned memory management; properties accessors; GSignal connection API
+(11:47:15 PM) ebassi: the rest is "nice to have"
+(11:47:37 PM) ebassi: oh, and probably GBinding - but that's just because I wrote it ;-)
+
 == Compatibility with all implementations.
 
 Currently, there are the following incompatibilities:

data/examples/04_webkit.rb

@@ -0,0 +1,16 @@
+# Based on http://www.idle-hacking.com/2010/02/webkit-ruby-and-gtk/
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'gir_ffi'
+
+GirFFI.setup :Gtk
+GirFFI.setup :WebKit
+
+Gtk.init
+
+win = Gtk::Window.new :toplevel
+wv = WebKit::WebView.new
+win.add(wv)
+win.show_all
+wv.open('http://www.google.com/')
+GObject.signal_connect(win, "destroy") { Gtk.main_quit }
+Gtk.main

data/lib/gir_ffi/arg_helper.rb

@@ -2,7 +2,9 @@ require 'gir_ffi/allocation_helper'
 
 module GirFFI
   module ArgHelper
+    # FIXME: Hideous.
     def self.object_to_inptr obj
+      return obj if obj.is_a? FFI::Pointer
       return obj.to_ptr if obj.respond_to? :to_ptr
       return nil if obj.nil?
       FFI::Pointer.new(obj.object_id)
@@ -18,11 +20,6 @@ module GirFFI
       typed_array_to_inptr :int32, ary
     end
 
-    # TODO: Use alias.
-    def self.int_array_to_inptr ary
-      int32_array_to_inptr ary
-    end
-
     def self.int16_array_to_inptr ary
       typed_array_to_inptr :int16, ary
     end
@@ -41,6 +38,13 @@ module GirFFI
       AllocationHelper.safe_malloc(len + 1).write_string(str).put_char(len, 0)
     end
 
+    def self.utf8_array_to_inptr ary
+      return nil if ary.nil?
+      ptr_ary = ary.map {|str| utf8_to_inptr str}
+      ptr_ary << nil
+      typed_array_to_inptr :pointer, ptr_ary
+    end
+
     def self.gtype_array_to_inptr ary
       case FFI.type_size(:size_t)
       when 4
@@ -52,6 +56,19 @@ module GirFFI
       end
     end
 
+    def self.gvalue_array_to_inptr ary
+      return nil if ary.nil?
+      raise NotImplementedError
+    end
+
+    class << self
+      alias int_array_to_inptr int32_array_to_inptr
+      alias gint8_array_to_inptr int8_array_to_inptr
+      alias gint16_array_to_inptr int16_array_to_inptr
+      alias gint32_array_to_inptr int32_array_to_inptr
+      alias gint64_array_to_inptr int64_array_to_inptr
+    end
+
     def self.cleanup_ptr ptr
       LibC.free ptr
     end
@@ -75,8 +92,8 @@ module GirFFI
       ptrs.each { |ptr| LibC.free ptr }
     end
 
-    def self.int_to_inoutptr val
-      int_pointer.write_int val
+    def self.int32_to_inoutptr val
+      int32_pointer.write_int32 val
     end
 
     def self.utf8_to_inoutptr str
@@ -84,7 +101,7 @@ module GirFFI
       pointer_pointer.write_pointer sptr
     end
 
-    def self.int_array_to_inoutptr ary
+    def self.int32_array_to_inoutptr ary
       block = int_array_to_inptr ary
       pointer_pointer.write_pointer block
     end
@@ -104,8 +121,16 @@ module GirFFI
       double_pointer.put_double 0, val
     end
 
-    def self.int_pointer
-      AllocationHelper.safe_malloc FFI.type_size(:int)
+    class << self
+      alias int_to_inoutptr int32_to_inoutptr
+      alias gint32_to_inoutptr int32_to_inoutptr
+      alias int_array_to_inoutptr int32_array_to_inoutptr
+      alias gint32_array_to_inoutptr int32_array_to_inoutptr
+      alias gdouble_to_inoutptr double_to_inoutptr
+    end
+
+    def self.int32_pointer
+      AllocationHelper.safe_malloc FFI.type_size(:int32)
     end
 
     def self.double_pointer
@@ -116,8 +141,14 @@ module GirFFI
       AllocationHelper.safe_malloc FFI.type_size(:pointer)
     end
 
-    def self.int_outptr
-      int_pointer.write_int 0
+    class << self
+      alias int_pointer int32_pointer
+      alias gint32_pointer int32_pointer
+      alias gdouble_pointer double_pointer
+    end
+
+    def self.int32_outptr
+      int32_pointer.write_int32 0
     end
 
     def self.double_outptr
@@ -132,14 +163,20 @@ module GirFFI
       pointer_outptr
     end
 
+    class << self
+      alias int_outptr int32_outptr
+      alias gint32_outptr int32_outptr
+      alias gdouble_outptr double_outptr
+    end
+
     # Converts an outptr to a pointer.
     def self.outptr_to_pointer ptr
       ptr.read_pointer
     end
 
     # Converts an outptr to an int.
-    def self.outptr_to_int ptr
-      ptr.read_int
+    def self.outptr_to_int32 ptr
+      ptr.read_int32
     end
 
     # Converts an outptr to a string.
@@ -162,20 +199,65 @@ module GirFFI
     end
 
     # Converts an outptr to an array of int.
-    def self.outptr_to_int_array ptr, size
+    def self.outptr_to_int32_array ptr, size
       block = ptr.read_pointer
       return nil if block.null?
-      ptr_to_int_array block, size
+      ptr_to_int32_array block, size
+    end
+
+    class << self
+      alias outptr_to_int outptr_to_int32
+      alias outptr_to_int_array outptr_to_int32_array
+      alias outptr_to_gint32 outptr_to_int32
+      alias outptr_to_gint32_array outptr_to_int32_array
+      alias outptr_to_gdouble outptr_to_double
     end
 
-    def self.ptr_to_int_array ptr, size
-      ptr.read_array_of_int(size)
+    def self.ptr_to_int32_array ptr, size
+      ptr.read_array_of_int32(size)
     end
 
     def self.ptr_to_utf8 ptr
       ptr.null? ? nil : ptr.read_string
     end
 
+    class << self
+      alias ptr_to_int_array ptr_to_int32_array
+      alias ptr_to_gint32_array ptr_to_int32_array
+    end
+
+    def self.utf8_array_to_glist arr
+      return nil if arr.nil?
+      arr.inject(nil) { |lst, str|
+        GLib.list_append lst, utf8_to_inptr(str) }
+    end
+
+    def self.utf8_array_to_gslist arr
+      return nil if arr.nil?
+      arr.reverse.inject(nil) { |lst, str|
+        GLib.slist_prepend lst, utf8_to_inptr(str) }
+    end
+
+    def self.glist_to_utf8_array ptr
+      return [] if ptr.null?
+      # FIXME: Quasi-circular dependency on generated module
+      list = GLib::List.wrap(ptr)
+      str = ptr_to_utf8(list[:data])
+      [str] + glist_to_utf8_array(list[:next])
+    end
+
+    def self.gslist_to_utf8_array ptr
+      return [] if ptr.null?
+      # FIXME: Quasi-circular dependency on generated module
+      list = GLib::SList.wrap(ptr)
+      str = ptr_to_utf8(list[:data])
+      [str] + gslist_to_utf8_array(list[:next])
+    end
+
+    def self.outgslist_to_utf8_array ptr
+      gslist_to_utf8_array ptr.read_pointer
+    end
+
     def self.wrap_in_callback_args_mapper namespace, name, prc
       return prc if FFI::Function === prc
       return nil if prc.nil?
@@ -191,34 +273,44 @@ module GirFFI
     end
 
     def self.map_single_callback_arg arg, info
-      type = info.type
-      tag = type.tag
-
-      case tag
+      case info.type.tag
       when :interface
-	iface = type.interface
-	if iface.type == :object
-	  object_pointer_to_object arg
-	else
-	  arg
-	end
+        map_interface_callback_arg arg, info
       when :utf8
 	ptr_to_utf8 arg
       when :void
-	if arg.null?
-	  nil
-	else
-	  begin
-	    ObjectSpace._id2ref arg.address
-	  rescue RangeError
-	    arg
-	  end
-	end
+        map_void_callback_arg arg
       else
 	arg
       end
     end
 
+    def self.map_interface_callback_arg arg, info
+      iface = info.type.interface
+      case iface.type
+      when :object
+        object_pointer_to_object arg
+      when :struct
+        klass = GirFFI::Builder.build_class iface
+        klass.wrap arg
+      else
+        arg
+      end
+    end
+
+    def self.map_void_callback_arg arg
+      if arg.null?
+        nil
+      else
+        begin
+          # TODO: Use custom object store.
+          ObjectSpace._id2ref arg.address
+        rescue RangeError
+          arg
+        end
+      end
+    end
+
     def self.check_error errpp
       errp = errpp.read_pointer
       raise GError.new(errp)[:message] unless errp.null?
@@ -245,7 +337,7 @@ module GirFFI
 	raise RuntimeError, "Unable to find info for type '#{tpname}' (#{tp})"
       end
 
-      klass = GirFFI::Builder.build_class info.namespace, info.name
+      klass = GirFFI::Builder.build_class info
       klass.wrap optr
     end