gir_ffi 0.0.3 → 0.0.4

data/DESIGN.rdoc

@@ -45,6 +45,15 @@ GLib::Instantiable; In standard GObject they are functions.
 Possibly, compatibility enhancing code can be added for these specific
 exceptions.
 
+== Reference Counting
+
+Because we can always make sure GObjects are unref'd when the Ruby object
+is GC'd, the mechanism of floating references actually gets in the way a
+bit. Therefore, when floating GObjects are constructed, GirFFI will sink
+them. All GObjects can then safely be unref'd using a Ruby finalizer.
+GObjects obtained through other mechanisms than with a constructor will be
+ref'd once when wrapping them in a ruby object.
+
 == Bootstrapping Class Design
 
 The interface to the GObject Introspection Repository itself is also

data/History.txt

@@ -1,3 +1,14 @@
+== 0.0.4 / 2010-12-14
+
+* Lots of changes to the internals.
+* Handle out-only arguments.
+* Make use of callbacks from other namespaces work.
+* Handle virtual methods where the invoker method has a different name.
+* Implement usable signal_connect and signal_emit.
+* Sink floating references when creating a GObject.
+* Implement Union type.
+* Many small bug fixes.
+
 == 0.0.3 / 2010-11-19
 
 * Update to restore Ruby 1.9 support.

data/TODO.rdoc

@@ -20,20 +20,17 @@ able to pass any Ruby object. On the other hand, these cases cannot be
 distinguished, based on the GIR data, from methods that take a pointer to
 any GObject.
 
-I'm currently leaning towards passing the object id as the value of the
-'gpointer'. Special overrided 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.
+I'm currently passing the object id as the value of the 'gpointer'. Special
+overrided 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.
 
 == Compatibility with all implementations.
 
 Currently, there are the following incompatibilities:
 
-* The MRI implementation does not allow invoking layout more than once. In
-  particular, this means you cannot subclass a struct and change (augment)
-  the layout. This *not* a problem in JRuby.
-
-* JRuby disables ObjectSpace by default, so using _id2ref is not ideal.
+* JRuby disables ObjectSpace by default, so using _id2ref for handling the
+  passing of generic pointers is not ideal.
 
 == See Also
 

data/examples/01_empty_window.rb

@@ -11,5 +11,5 @@ GirFFI.setup :Gtk
 Gtk.init
 win = Gtk::Window.new :toplevel
 win.show
-GObject.signal_connect_data win, "destroy", Proc.new { Gtk.main_quit }, nil, nil, 0
+GObject.signal_connect(win, "destroy") { Gtk.main_quit }
 Gtk.main

data/examples/02_hello_world.rb

@@ -11,16 +11,16 @@ GirFFI.setup :Gtk
 Gtk.init
 
 win = Gtk::Window.new(:toplevel)
-GObject.signal_connect_data win, "delete-event", FFI::Function.new(:bool, [:pointer, :pointer]) {
+GObject.signal_connect win, "delete-event" do
   puts "delete event occured"
   true
-}, nil, nil, 0
+end
 
-GObject.signal_connect_data win, "destroy", Proc.new { Gtk.main_quit }, nil, nil, 0
+GObject.signal_connect(win, "destroy") { Gtk.main_quit }
 win.set_border_width 10
 
 but = Gtk::Button.new_with_label("Hello World")
-GObject.signal_connect_data but, "clicked", Proc.new { win.destroy }, nil, nil, :swapped
+GObject.signal_connect(but, "clicked") { win.destroy }
 
 win.add but
 

data/examples/03_upgraded_hello_world.rb

@@ -8,20 +8,19 @@ require 'gir_ffi'
 GirFFI.setup :GObject
 GirFFI.setup :Gtk
 
-callback = FFI::Function.new :void, [:pointer, :pointer],
-  &GirFFI::ArgHelper.mapped_callback_args { |widget, data|
-    puts "Hello again - #{data} was pressed"
-  }
+callback = lambda { |widget, data|
+  puts "Hello again - #{data} was pressed"
+}
 
 Gtk.init
 
 win = Gtk::Window.new(:toplevel)
 win.set_title "Hello Buttons!"
 
-GObject.signal_connect_data win, "delete-event", FFI::Function.new(:bool, [:pointer, :pointer]) {
+GObject.signal_connect win, "delete-event" do
   Gtk.main_quit
   false
-}, nil, nil, 0
+end
 
 win.set_border_width 10
 
@@ -29,12 +28,12 @@ box = Gtk::HBox.new(false, 0)
 win.add box
 
 button = Gtk::Button.new_with_label("Button 1")
-GObject.signal_connect_data button, "clicked", callback, "button 1", nil, 0
+GObject.signal_connect button, "clicked", "button 1", &callback
 box.pack_start button, true, true, 0
 button.show
 
 button = Gtk::Button.new_with_label("Button 2")
-GObject.signal_connect_data button, "clicked", callback, "button 2", nil, 0
+GObject.signal_connect button, "clicked", "button 2", &callback
 box.pack_start button, true, true, 0
 button.show
 

data/lib/gir_ffi.rb

@@ -38,10 +38,6 @@ module GirFFI
   def self.setup module_name
     module_name = module_name.to_s
     GirFFI::Builder.build_module module_name
-    begin
-      require "gir_ffi/overrides/#{module_name.downcase}"
-    rescue LoadError
-    end
   end
 end
 # EOF

data/lib/gir_ffi/arg_helper.rb

@@ -22,14 +22,21 @@ module GirFFI
 	AllocationHelper.safe_malloc(len + 1).write_string(str).put_char(len, 0)
       }
 
-      block = AllocationHelper.safe_malloc FFI.type_size(:pointer) * ptrs.length
+      ptr_size = FFI.type_size(:pointer)
+      block = AllocationHelper.safe_malloc ptr_size * ptrs.length
       block.write_array_of_pointer ptrs
 
-      argv = AllocationHelper.safe_malloc FFI.type_size(:pointer)
+      argv = AllocationHelper.safe_malloc ptr_size
       argv.write_pointer block
       argv
     end
 
+    def self.double_to_inoutptr val
+      ptr = AllocationHelper.safe_malloc FFI.type_size(:double)
+      ptr.put_double 0, val
+      return ptr
+    end
+
     # Converts an outptr to an int, then frees the outptr.
     def self.outptr_to_int ptr
       value = ptr.read_int
@@ -58,6 +65,13 @@ module GirFFI
       end
     end
 
+    # Converts an outptr to a double, then frees the outptr.
+    def self.outptr_to_double ptr
+      value = ptr.get_double 0
+      LibC.free ptr
+      value
+    end
+
     def self.mapped_callback_args prc=nil, &block
       return prc if FFI::Function === prc
       if prc.nil?
@@ -79,5 +93,16 @@ module GirFFI
 	prc.call(*mapped)
       end
     end
+
+    def self.check_error errpp
+      errp = errpp.read_pointer
+      raise GError.new(errp)[:message] unless errp.null?
+    end
+
+    def self.sink_if_floating gobject
+      if GirFFI::GObject.object_is_floating(gobject)
+	GirFFI::GObject.object_ref_sink(gobject)
+      end
+    end
   end
 end

data/lib/gir_ffi/builder.rb

@@ -1,8 +1,6 @@
 require 'gir_ffi/arg_helper'
 require 'gir_ffi/function_definition_builder'
-require 'gir_ffi/constructor_definition_builder'
-require 'gir_ffi/method_missing_definition_builder'
-require 'gir_ffi/base'
+require 'gir_ffi/class_base'
 require 'gir_ffi/class_builder'
 require 'gir_ffi/module_builder'
 require 'gir_ffi/builder_helper'
@@ -12,6 +10,7 @@ module GirFFI
   # introspection repository. Call its build_module and build_class methods
   # to create the modules and classes used in your program.
   module Builder
+    extend BuilderHelper
     def self.build_class namespace, classname
       ClassBuilder.new(namespace, classname).generate
     end
@@ -20,81 +19,6 @@ module GirFFI
       ModuleBuilder.new(namespace).generate
     end
 
-    def self.setup_method namespace, classname, method
-      go = method_introspection_data namespace, classname, method.to_s
-
-      return false if go.nil?
-      return false if go.type != :function
-
-      klass = build_class namespace, classname
-      modul = build_module namespace
-      lib = modul.const_get(:Lib)
-
-      attach_ffi_function lib, go
-
-      meta = (class << klass; self; end)
-      meta.class_eval function_definition(go, lib)
-
-      true
-    end
-
-    def self.setup_function namespace, method
-      go = function_introspection_data namespace, method.to_s
-
-      return false if go.nil?
-      return false if go.type != :function
-
-      modul = build_module namespace
-      lib = modul.const_get(:Lib)
-
-      attach_ffi_function lib, go
-
-      meta = (class << modul; self; end)
-      meta.class_eval function_definition(go, lib)
-
-      true
-    end
-
-    def self.setup_instance_method namespace, classname, method
-      go = method_introspection_data namespace, classname, method.to_s
-
-      return false if go.nil?
-      return false if go.type != :function
-
-      klass = build_class namespace, classname
-      modul = build_module namespace
-      lib = modul.const_get(:Lib)
-
-      attach_ffi_function lib, go
-
-      klass.class_eval "undef #{method}"
-      klass.class_eval function_definition(go, lib)
-
-      true
-    end
-
-    # All methods below will be made private at the end.
- 
-    def self.function_definition info, libmodule
-      if info.constructor?
-	fdbuilder = ConstructorDefinitionBuilder.new info, libmodule
-      else
-	fdbuilder = FunctionDefinitionBuilder.new info, libmodule
-      end
-      fdbuilder.generate
-    end
-
-    def self.function_introspection_data namespace, function
-      gir = IRepository.default
-      return gir.find_by_name namespace, function.to_s
-    end
-
-    def self.method_introspection_data namespace, object, method
-      gir = IRepository.default
-      objectinfo = gir.find_by_name namespace, object.to_s
-      return objectinfo.find_method method
-    end
-
     def self.attach_ffi_function lib, info
       sym = info.symbol
       argtypes = ffi_function_argument_types info
@@ -103,6 +27,8 @@ module GirFFI
       lib.attach_function sym, argtypes, rt
     end
 
+    # All methods below will be made private at the end.
+
     def self.ffi_function_argument_types info
       types = info.args.map do |a|
 	iarginfo_to_ffitype a
@@ -119,11 +45,14 @@ module GirFFI
     end
 
     def self.itypeinfo_to_ffitype info
+      tag = info.tag
+
       if info.pointer?
-	return :string if info.tag == :utf8
+	return :string if tag == :utf8
 	return :pointer
       end
-      case info.tag
+
+      case tag
       when :interface
 	interface = info.interface
 	case interface.type
@@ -139,12 +68,13 @@ module GirFFI
       when :GType
 	return :int32
       else
-	return info.tag
+	return tag
       end
     end
 
     def self.iarginfo_to_ffitype info
       return :pointer if info.direction == :inout
+      return :pointer if info.direction == :out
       return itypeinfo_to_ffitype info.type
     end
 
@@ -154,14 +84,11 @@ module GirFFI
 
       sym = interface.name.to_sym
 
-      # FIXME: Rescue is ugly here.
-      ft = lib.find_type sym rescue nil
-      if ft.nil?
+      optionally_define_constant modul, sym do
 	args = ffi_function_argument_types interface
 	ret = ffi_function_return_type interface
 	lib.callback sym, args, ret
       end
-      sym
     end
 
     # Set up method access.
@@ -169,7 +96,7 @@ module GirFFI
       private_class_method m.to_sym
     end
     public_class_method :build_module, :build_class
-    public_class_method :setup_method, :setup_function, :setup_instance_method
     public_class_method :itypeinfo_to_ffitype
+    public_class_method :attach_ffi_function
   end
 end

data/lib/gir_ffi/builder_helper.rb

@@ -1,6 +1,6 @@
 module GirFFI
   module BuilderHelper
-    def self.const_defined_for parent, name
+    def const_defined_for parent, name
       if RUBY_VERSION < "1.9"
 	parent.const_defined? name
       else
@@ -8,25 +8,12 @@ module GirFFI
       end
     end
 
-    def self.optionally_define_constant parent, name
+    def optionally_define_constant parent, name
       unless const_defined_for parent, name
 	parent.const_set name, yield
       end
       parent.const_get name
     end
 
-    def self.get_or_define_module parent, name
-      optionally_define_constant(parent, name) { Module.new }
-    end
-
-    def self.get_or_define_class namespace, name, parent
-      BuilderHelper.optionally_define_constant namespace, name do
-	if parent.nil?
-	  klass = Class.new
-	else
-	  klass = Class.new parent
-	end
-      end
-    end
   end
 end

data/lib/gir_ffi/class_base.rb

@@ -0,0 +1,51 @@
+require 'forwardable'
+module GirFFI
+  # Base class for all generated classes. Contains code for dealing with
+  # the generated Struct classes.
+  class ClassBase
+    extend Forwardable
+    def_delegators :@struct, :[], :[]=, :to_ptr
+
+    def initialize(*args)
+      # TODO: Handle NULL pointer.
+      @struct = ffi_structure.new(*args)
+    end
+
+    def ffi_structure
+      self.class.ffi_structure
+    end
+
+    def gir_ffi_builder
+      self.class.gir_ffi_builder
+    end
+
+    def method_missing method, *arguments, &block
+      result = gir_ffi_builder.setup_instance_method method.to_s
+      return super unless result
+      self.send method, *arguments, &block
+    end
+
+    def self.method_missing method, *arguments, &block
+      result = gir_ffi_builder.setup_method method.to_s
+      return super unless result
+      self.send method, *arguments, &block
+    end
+
+    class << self
+      def ffi_structure
+	self.const_get(:Struct)
+      end
+
+      def gir_info
+	self.const_get :GIR_INFO
+      end
+
+      def gir_ffi_builder
+	self.const_get :GIR_FFI_BUILDER
+      end
+
+      alias_method :_real_new, :new
+      undef new
+    end
+  end
+end