gir_ffi 0.2.3 → 0.3.0

data/History.txt

@@ -1,3 +1,17 @@
+== 0.3.0 / 2012-04-09
+
+* Improve process of defining initializers in derived classes.
+* Make interfaces know their GType.
+* Make classes created by the Unintrospectable builder know their GType.
+* Create property accessors instead of field accessors for GObjects.
+* Add Ruby-style getter and setter methods (by Antonio Terceiro).
+* Add #signal_connect instance method (by Antonio Terceiro).
+* Make GirFFI's tests pass with gobject-introspection 0.10.
+* Improve unintrospectable type handling.
+* Bug fixes and refactorings.
+* Start implementing #define_type, for creating descendent types that
+  the GObject system knows about.
+
 == 0.2.3 / 2011-12-31
 
 * Fix issue #7: methods that take GValues will autoconvert other values.

data/README.rdoc

@@ -4,6 +4,8 @@ by Matijs van Zuijlen
 
 http://www.github.com/mvz/ruby-gir-ffi
 
+{<img src="https://secure.travis-ci.org/mvz/ruby-gir-ffi.png" />}[http://travis-ci.org/mvz/ruby-gir-ffi]
+
 == Description
 
 Ruby bindings for GNOME using the GObject Introspection Repository.
@@ -86,7 +88,7 @@ If you want to send pull requests or patches, please:
 
 == License
 
-Copyright (c) 2009--2011 Matijs van Zuijlen
+Copyright (c) 2009--2012 Matijs van Zuijlen
 
 GirFFI is free software, distributed under the terms of the GNU Lesser
 General Public License, version 2.1 or later. See the file COPYING.LIB for

data/examples/02_hello_world.rb

@@ -14,6 +14,7 @@ GObject.signal_connect win, "delete-event" do
 end
 
 GObject.signal_connect(win, "destroy") { Gtk.main_quit }
+# FIXME: #border_width= should work
 win.set_border_width 10
 
 but = Gtk::Button.new_with_label("Hello World")

data/examples/03_upgraded_hello_world.rb

@@ -12,13 +12,14 @@ callback = lambda { |widget, data|
 Gtk.init
 
 win = Gtk::Window.new(:toplevel)
-win.set_title "Hello Buttons!"
+win.title= "Hello Buttons!"
 
 GObject.signal_connect win, "delete-event" do
   Gtk.main_quit
   false
 end
 
+# FIXME: #border_width= should work
 win.set_border_width 10
 
 box = Gtk::HBox.new(false, 0)

data/examples/05_notification.rb

@@ -12,8 +12,8 @@ Notify.init "notification test"
 
 # Basic set up of the notification.
 nf = Notify::Notification.new "Hello!", "Hi there.", "gtk-dialog-info"
-nf.set_timeout 3000
-nf.set_urgency :critical
+nf.timeout = 3000
+nf.urgency = :critical
 
 # Show a button 'Test' in the notification, with a callback function.
 nf.add_action "test", "Test", Proc.new { |obj, action, user_data|

data/examples/hard_coded.rb

@@ -106,25 +106,48 @@ module Gtk
   end
 
   class Button < Container
-    def initialize ptr
-      @gobj = ptr
-    end
     class << self
       alias :real_new :new
     end
+
+    def self.new *args
+      obj = self.real_new *args
+      ptr = Lib.gtk_button_new()
+      obj.instance_variable_set :@gobj, ptr
+      obj
+    end
+
+    def self.new_with_label text, *args
+      obj = self.real_new *args
+      ptr = Lib.gtk_button_new_with_label(text)
+      obj.instance_variable_set :@gobj, ptr
+      obj
+    end
+  end
+
+  class MyButton < Button
+    def initialize sym
+      puts "Initializing a #{self.class} with symbol #{sym}"
+    end
+
     def self.new
-      self.real_new Lib.gtk_button_new()
+      super :foo
     end
-    def self.new_with_label text
-      self.real_new Lib.gtk_button_new_with_label(text)
+
+    def self.new_with_label sym
+      super "Hello world", sym
     end
   end
 end
 
 (my_len, my_args) = Gtk.init ARGV.length + 1, [$0, *ARGV]
-p my_len, my_args
+p [my_len, my_args]
 win = Gtk::Window.new(:GTK_WINDOW_TOPLEVEL)
-btn = Gtk::Button.new_with_label('Hello World')
+
+#btn = Gtk::Button.new_with_label('Hello World')
+#btn = Gtk::MyButton.new
+btn = Gtk::MyButton.new_with_label :foobar2
+
 win.add btn
 
 quit_prc = Proc.new { Gtk.main_quit }

data/lib/ffi-glib/array.rb

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

data/lib/ffi-glib/container_class_methods.rb

@@ -0,0 +1,25 @@
+module GLib
+  module ContainerClassMethods
+    def wrap typespec, ptr
+      super(ptr).tap do |it|
+        break if it.nil?
+        it.reset_typespec typespec
+      end
+    end
+
+    def from typespec, it
+      case it
+      when nil
+        nil
+      when FFI::Pointer
+        wrap typespec, it
+      when self
+        it.reset_typespec typespec
+      else
+        from_enumerable typespec, it
+      end
+    end
+  end
+end
+
+

data/lib/ffi-glib/hash_table.rb

@@ -1,9 +1,14 @@
+require 'ffi-glib/container_class_methods'
+
 module GLib
   load_class :HashTable
 
   # Overrides for GHashTable, GLib's hash table implementation.
   class HashTable
     include Enumerable
+    extend ContainerClassMethods
+
+    # TODO: Restructure so these can become attr_readers.
     attr_accessor :key_type
     attr_accessor :value_type
 
@@ -27,50 +32,48 @@ module GLib
     end
 
     class << self
-      undef :new
-      def new  keytype, valtype
-        hash_fn, eq_fn = case keytype
-                         when :utf8
-                           lib = ::GLib::Lib.ffi_libraries.first
-                           [ FFI::Function.new(:uint, [:pointer], lib.find_function("g_str_hash")),
-                             FFI::Function.new(:int, [:pointer, :pointer], lib.find_function("g_str_equal"))]
-                         else
-                           [nil, nil]
-                         end
-        wrap [keytype, valtype], Lib.g_hash_table_new(hash_fn, eq_fn)
-      end
+      remove_method :new
+    end
+
+    def self.new keytype, valtype
+      wrap [keytype, valtype], Lib.g_hash_table_new(
+        hash_function_for(keytype), equality_function_for(keytype))
+    end
 
-      def wrap types, ptr
-        super(ptr).tap do |it|
-          return nil if it.nil?
-          keytype, valtype = *types
-          it.key_type = keytype
-          it.value_type = valtype
-        end
+    def reset_typespec typespec
+      self.key_type, self.value_type = *typespec
+      self
+    end
+
+    def self.from_enumerable typespec, hash
+      ghash = self.new(*typespec)
+      hash.each do |key, val|
+        ghash.insert key, val
       end
+      ghash
+    end
 
-      def from_hash types, hash
-        keytype, valtype = *types
-        return nil if hash.nil?
-        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
+    def self.hash_function_for keytype
+      case keytype
+      when :utf8
+        FFI::Function.new(:uint, [:pointer], find_support_funtion("g_str_hash"))
+      else
+        nil
       end
+    end
 
-      def from types, it
-        if it.is_a? FFI::Pointer
-          wrap types, it
-        else
-          from_hash types, it
-        end
+    def self.equality_function_for keytype
+      case keytype
+      when :utf8
+        FFI::Function.new(:int, [:pointer, :pointer], find_support_funtion("g_str_equal"))
+      else
+        nil
       end
     end
+
+    def self.find_support_funtion name
+      lib = ::GLib::Lib.ffi_libraries.first
+      lib.find_function(name)
+    end
   end
 end

data/lib/ffi-glib/list.rb

@@ -7,34 +7,27 @@ module GLib
   class List
     include ListMethods
 
-    # Override default field accessors.
-    undef :next
-    undef :data
-
-    alias :next :tail
-    alias :data :head
-
     class << self
-      undef :new
-      def new type
-        _real_new(FFI::Pointer.new(0)).tap {|it|
-          it.element_type = type}
-      end
+      remove_method :new
+    end
 
-      def from_array type, arr
-        return nil if arr.nil?
-        if arr.is_a? self
-          arr.element_type = type
-          return arr
-        end
-        arr.inject(self.new type) { |lst, val|
-          lst.append val }
+    def self.new type
+      _real_new.tap do |it|
+        struct = ffi_structure.new(FFI::Pointer.new(0))
+        it.instance_variable_set :@struct, struct
+        it.element_type = type
       end
     end
 
+    def self.from_enumerable type, arr
+      arr.inject(self.new type) { |lst, val|
+        lst.append val }
+    end
+
     def append data
-      data_ptr = GirFFI::InPointer.from(element_type, data)
-      self.class.wrap(element_type, Lib.g_list_append(self, data_ptr))
+      elm_t = element_type
+      data_ptr = GirFFI::InPointer.from(elm_t, data)
+      self.class.wrap(elm_t, Lib.g_list_append(self, data_ptr))
     end
   end
 end

data/lib/ffi-glib/list_methods.rb

@@ -1,10 +1,22 @@
+require 'ffi-glib/container_class_methods'
+
 module GLib
   module ListMethods
     include Enumerable
     attr_accessor :element_type
 
     def self.included base
-      base.extend ClassMethods
+      base.extend ContainerClassMethods
+      # Override default field accessors.
+      replace_method base, :next, :tail
+      replace_method base, :data, :head
+    end
+
+    def self.replace_method base, old, new
+      base.class_eval do
+        remove_method old
+        alias_method old, new
+      end
     end
 
     def each
@@ -25,21 +37,9 @@ module GLib
       GirFFI::ArgHelper.cast_from_pointer(element_type, @struct[:data])
     end
 
-    module ClassMethods
-      def wrap elmttype, ptr
-        super(ptr).tap do |it|
-          break if it.nil?
-          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
+    def reset_typespec typespec
+      self.element_type = typespec
+      self
     end
   end
 end

data/lib/ffi-glib/ptr_array.rb

@@ -9,18 +9,18 @@ module GLib
     attr_accessor :element_type
 
     class << self
-      undef :new
-      def new type
-        wrap(Lib.g_ptr_array_new).tap {|it|
-          it.element_type = type}
-      end
-
+      remove_method :new
       # Remove stub generated by builder.
-      undef :add if method_defined? :add
+      remove_method :add if method_defined? :add
+    end
 
-      def add array, data
-        array.add data
-      end
+    def self.new type
+      wrap(Lib.g_ptr_array_new).tap {|it|
+        it.element_type = type}
+    end
+
+    def self.add array, data
+      array.add data
     end
 
     def add data
@@ -28,12 +28,17 @@ module GLib
       Lib.g_ptr_array_add self, ptr
     end
 
+    # 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)
+    end
+
     def each
-      prc = Proc.new {|valptr, userdata|
-        val = GirFFI::ArgHelper.cast_from_pointer element_type, valptr
-        yield val
-      }
-      Lib.g_ptr_array_foreach self.to_ptr, prc, nil
+      @struct[:len].times.each do |idx|
+        yield index(idx)
+      end
     end
   end
 end

data/lib/ffi-glib/s_list.rb

@@ -7,35 +7,27 @@ module GLib
   class SList
     include ListMethods
 
-    # Override default field accessors.
-    undef :next
-    undef :data
-
-    alias :next :tail
-    alias :data :head
-
     class << self
-      undef :new
-      def new type
-        _real_new(FFI::Pointer.new(0)).tap {|it|
-          it.element_type = type}
-      end
+      remove_method :new
+    end
 
-      def from_array type, arr
-        return nil if arr.nil?
-        if arr.is_a? self
-          arr.element_type = type
-          return arr
-        end
-        arr.reverse.inject(self.new type) { |lst, val|
-          lst.prepend val }
+    def self.new type
+      _real_new.tap do |it|
+        struct = ffi_structure.new(FFI::Pointer.new(0))
+        it.instance_variable_set :@struct, struct
+        it.element_type = type
       end
     end
 
-    def prepend data
-      data_ptr = GirFFI::InPointer.from(element_type, data)
-      self.class.wrap(element_type, Lib.g_slist_prepend(self, data_ptr))
+    def self.from_enumerable type, arr
+      arr.reverse.inject(self.new type) { |lst, val|
+        lst.prepend val }
     end
 
+    def prepend data
+      elm_t = element_type
+      data_ptr = GirFFI::InPointer.from(elm_t, data)
+      self.class.wrap(elm_t, Lib.g_slist_prepend(self, data_ptr))
+    end
   end
 end

data/lib/ffi-glib.rb

@@ -9,6 +9,11 @@ require 'ffi-glib/ptr_array'
 require 'ffi-glib/strv'
 
 module GLib
+  # FIXME: Remove eventually.
+  def self.main_loop_new context, is_running
+    ::GLib::MainLoop.wrap(::GLib::Lib.g_main_loop_new context, is_running)
+  end
+
   load_class :HFunc
   load_class :HashFunc
   load_class :EqualFunc
@@ -38,5 +43,7 @@ module GLib
     attach_function :g_ptr_array_add, [:pointer, :pointer], :void
     attach_function :g_ptr_array_foreach, [:pointer, Func, :pointer],
       :pointer
+
+    attach_function :g_main_loop_new, [:pointer, :bool], :pointer
   end
 end

data/lib/ffi-gobject/base.rb

@@ -22,17 +22,4 @@ module GObject
   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

@@ -1,8 +1,14 @@
+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"
     _setup_instance_method "get_property"
     _setup_instance_method "set_property"
 

data/lib/ffi-gobject/ruby_style.rb

@@ -0,0 +1,21 @@
+module GObject
+
+  module RubyStyle
+
+    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
+
+  end
+
+end

data/lib/ffi-gobject.rb

@@ -8,6 +8,7 @@ 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
   def self.type_init
@@ -40,6 +41,16 @@ module GObject
     type_from_instance_pointer instance.to_ptr
   end
 
+  def self.object_class_from_instance instance
+    object_class_from_instance_pointer instance.to_ptr
+  end
+
+  def self.object_class_from_instance_pointer inst_ptr
+    return nil if inst_ptr.null?
+    klsptr = inst_ptr.get_pointer 0
+    ObjectClass.wrap klsptr
+  end
+
   _setup_method :signal_emitv
 
   def self.signal_lookup_from_instance signal, object
@@ -65,10 +76,18 @@ module GObject
     Lib.g_signal_connect_data object, signal, callback, data_ptr, nil, 0
   end
 
+  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)
+    ParamSpecInt.wrap(ptr)
+  end
+
   load_class :Callback
   load_class :ClosureNotify
   load_class :ConnectFlags
   load_class :ClosureMarshal
+  load_class :ParamFlags
 
   module Lib
     attach_function :g_type_init, [], :void
@@ -77,12 +96,37 @@ module GObject
     attach_function :g_object_unref, [:pointer], :void
     attach_function :g_object_is_floating, [:pointer], :bool
 
+    # XXX: For older GObject/gobject-introspection.
+    unless method_defined? :g_object_newv
+      attach_function :g_object_newv, [:size_t, :uint, :pointer], :pointer
+    end
+
+    attach_function :g_strv_get_type, [], :size_t
+    attach_function :g_hash_table_get_type, [], :size_t
+
     attach_function :g_signal_connect_data,
       [:pointer, :string, Callback, :pointer, ClosureNotify,
         ConnectFlags],
         :ulong
     attach_function :g_closure_set_marshal,
       [:pointer, ClosureMarshal], :void
+
+    attach_function :g_param_spec_int,
+      [:string, :string, :string, :int32, :int32, :int32, ParamFlags],
+      :pointer
   end
 
+  TYPE_STRV = Lib.g_strv_get_type
+  TYPE_HASH_TABLE = Lib.g_hash_table_get_type
+
+  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_introspection/i_object_info.rb

@@ -5,12 +5,19 @@ module GObjectIntrospection
     def type_name
       Lib.g_object_info_get_type_name @gobj
     end
+
     def type_init
       Lib.g_object_info_get_type_init @gobj
     end
+
     def abstract?
       Lib.g_object_info_get_abstract @gobj
     end
+
+    def fundamental?
+      Lib.g_object_info_get_fundamental @gobj
+    end
+
     def parent
       IObjectInfo.wrap(Lib.g_object_info_get_parent @gobj)
     end

data/lib/ffi-gobject_introspection/lib.rb

@@ -207,6 +207,7 @@ module GObjectIntrospection
     attach_function :g_object_info_get_n_constants, [:pointer], :int
     attach_function :g_object_info_get_constant, [:pointer, :int], :pointer
     attach_function :g_object_info_get_class_struct, [:pointer], :pointer
+    attach_function :g_object_info_get_fundamental, [:pointer], :bool
 
     # IVFuncInfo