gir_ffi 0.0.10 → 0.0.11

data/lib/gir_ffi/callback_helper.rb

@@ -0,0 +1,58 @@
+module GirFFI
+  module CallbackHelper
+    def self.wrap_in_callback_args_mapper namespace, name, prc
+      return prc if FFI::Function === prc
+      return nil if prc.nil?
+      info = IRepository.default.find_by_name namespace, name
+      return Proc.new do |*args|
+	prc.call(*map_callback_args(args, info))
+      end
+    end
+
+    def self.map_callback_args args, info
+      args.zip(info.args).map { |arg, inf|
+	map_single_callback_arg arg, inf }
+    end
+
+    # TODO: Use GirFFI::ReturnValue classes for mapping.
+    def self.map_single_callback_arg arg, info
+      case info.argument_type.tag
+      when :interface
+        map_interface_callback_arg arg, info
+      when :utf8
+	ArgHelper.ptr_to_utf8 arg
+      when :void
+        map_void_callback_arg arg
+      else
+	arg
+      end
+    end
+
+    def self.map_interface_callback_arg arg, info
+      iface = info.argument_type.interface
+      case iface.info_type
+      when :object
+        ArgHelper.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
+  end
+end
+

data/lib/gir_ffi/class_base.rb

@@ -15,19 +15,19 @@ module GirFFI
       self.class.ffi_structure
     end
 
-    def gir_ffi_builder
-      self.class.gir_ffi_builder
+    def _builder
+      self.class._builder
     end
 
     def setup_and_call method, *arguments, &block
-      unless gir_ffi_builder.setup_instance_method method.to_s
+      unless _builder.setup_instance_method method.to_s
         raise RuntimeError, "Unable to set up instance method #{method} in #{self}"
       end
       self.send method, *arguments, &block
     end
 
     def self.setup_and_call method, *arguments, &block
-      unless gir_ffi_builder.setup_method method.to_s
+      unless _builder.setup_method method.to_s
         raise RuntimeError, "Unable to set up method #{method} in #{self}"
       end
       self.send method, *arguments, &block
@@ -42,10 +42,22 @@ module GirFFI
 	self.const_get :GIR_INFO
       end
 
-      def gir_ffi_builder
+      def _builder
 	self.const_get :GIR_FFI_BUILDER
       end
 
+      def _find_signal name
+        _builder.find_signal name
+      end
+
+      def _setup_method name
+        _builder.setup_method name
+      end
+
+      def _setup_instance_method name
+        _builder.setup_instance_method name
+      end
+
       alias_method :_real_new, :new
       undef new
 

data/lib/gir_ffi/i_repository.rb

@@ -1,6 +1,5 @@
 require 'singleton'
 require 'gir_ffi/lib'
-require 'gir_ffi/g_object'
 require 'gir_ffi/g_error'
 require 'gir_ffi/i_base_info'
 require 'gir_ffi/i_callable_info'
@@ -53,7 +52,6 @@ module GirFFI
     }
 
     def initialize
-      GObject.type_init
       @gobj = Lib::g_irepository_get_default
     end
 
@@ -63,12 +61,10 @@ module GirFFI
       self.instance
     end
 
-    # TODO: Make sure GType is initialized first.
     def self.prepend_search_path path
       Lib.g_irepository_prepend_search_path path
     end
 
-    # TODO: Make sure GType is initialized first.
     def self.type_tag_to_string type
       Lib.g_type_tag_to_string type
     end

data/lib/gir_ffi/in_out_pointer.rb

@@ -0,0 +1,76 @@
+module GirFFI
+  # The InOutPointer class handles conversion between ruby types and
+  # pointers for arguments with direction :inout and :out.
+  class InOutPointer < FFI::Pointer
+    def initialize ptr, type, ffi_type
+      super ptr
+      @ffi_type = ffi_type
+      @value_type = type
+    end
+
+    def to_value
+      value = self.send "get_#{@ffi_type}", 0
+      adjust_value_out value
+    end
+
+    private
+
+    def adjust_value_out value
+      case @value_type
+      when :gboolean
+        (value != 0)
+      when :utf8
+        ArgHelper.ptr_to_utf8 value
+      else
+        value
+      end
+    end
+
+    def self.for type
+      ffi_type = type_to_ffi_type type
+      ptr = AllocationHelper.safe_malloc(FFI.type_size ffi_type)
+      ptr.send "put_#{ffi_type}", 0, 0
+      self.new ptr, type, ffi_type
+    end
+
+    def self.from type, value
+      value = adjust_value_in type, value
+      ffi_type = type_to_ffi_type type
+      ptr = AllocationHelper.safe_malloc(FFI.type_size ffi_type)
+      ptr.send "put_#{ffi_type}", 0, value
+      self.new ptr, type, ffi_type
+    end
+
+    def self.from_array type, array
+      return nil if array.nil?
+      ptr = InPointer.from_array(type, array)
+      self.from :pointer, ptr
+    end
+
+    class << self
+      # TODO: Make separate module to hold type info.
+      def type_to_ffi_type type
+        case type
+        when :gboolean
+          :int32
+        when :utf8
+          :pointer
+        else
+          GirFFI::Builder::TAG_TYPE_MAP[type] || type
+        end
+      end
+
+      def adjust_value_in type, value
+        case type
+        when :gboolean
+          (value ? 1 : 0)
+        when :utf8
+          InPointer.from :utf8, value
+        else
+          value
+        end
+      end
+    end
+  end
+end
+

data/lib/gir_ffi/in_pointer.rb

@@ -0,0 +1,46 @@
+module GirFFI
+  # The InPointer class handles conversion from ruby types to pointers for
+  # arguments with direction :in. This is used for arguments that are
+  # arrays, strings, or interfaces.
+  class InPointer < FFI::Pointer
+    def self.from_array type, ary
+      return nil if ary.nil?
+      return from_utf8_array ary if type == :utf8
+      return from_interface_pointer_array ary if type == :interface_pointer
+
+      ffi_type = GirFFI::Builder::TAG_TYPE_MAP[type] || type
+      block = ArgHelper.allocate_array_of_type ffi_type, ary.length
+      block.send "put_array_of_#{ffi_type}", 0, ary
+
+      self.new block
+    end
+
+    def self.from type, val
+      return nil if val.nil?
+      from_utf8 val
+    end
+
+    class << self
+
+      private
+
+      def from_utf8_array ary
+        ptr_ary = ary.map {|str| self.from :utf8, str}
+        ptr_ary << nil
+        self.from_array :pointer, ptr_ary
+      end
+
+      def from_interface_pointer_array ary
+        ptr_ary = ary.map {|ifc| ifc.to_ptr}
+        ptr_ary << nil
+        self.from_array :pointer, ptr_ary
+      end
+
+      def from_utf8 str
+        len = str.bytesize
+        ptr = AllocationHelper.safe_malloc(len + 1).write_string(str).put_char(len, 0)
+        self.new ptr
+      end
+    end
+  end
+end

data/lib/gir_ffi/interface_base.rb

@@ -0,0 +1,12 @@
+module GirFFI
+  module InterfaceBase
+    def _builder
+      self.const_get :GIR_FFI_BUILDER
+    end
+
+    def _setup_instance_method name
+      _builder.setup_instance_method name
+    end
+  end
+end
+

data/lib/gir_ffi/module_base.rb

@@ -1,19 +1,23 @@
 module GirFFI
   module ModuleBase
     def method_missing method, *arguments, &block
-      result = gir_ffi_builder.setup_function method.to_s
+      result = _setup_method method.to_s
       return super unless result
       self.send method, *arguments, &block
     end
 
     def const_missing classname
-      klass = gir_ffi_builder.build_class classname.to_s
+      klass = _builder.build_namespaced_class classname.to_s
       return super if klass.nil?
       klass
     end
 
-    def gir_ffi_builder
+    def _builder
       self.const_get :GIR_FFI_BUILDER
     end
+
+    def _setup_method name
+      _builder.setup_method name
+    end
   end
 end

data/lib/gir_ffi/overrides/glib.rb

@@ -39,20 +39,27 @@ module GirFFI
       def self.attach_non_introspectable_functions base
         base::Lib.attach_function :g_slist_prepend, [:pointer, :pointer],
           :pointer
+
         base::Lib.attach_function :g_list_append, [:pointer, :pointer],
           :pointer
+
         base::Lib.attach_function :g_hash_table_foreach,
           [:pointer, base::HFunc, :pointer], :void
         base::Lib.attach_function :g_hash_table_new,
           [base::HashFunc, base::EqualFunc], :pointer
         base::Lib.attach_function :g_hash_table_insert,
           [:pointer, :pointer, :pointer], :void
+
         base::Lib.attach_function :g_byte_array_new, [], :pointer
         base::Lib.attach_function :g_byte_array_append,
           [:pointer, :pointer, :uint], :pointer
+
         base::Lib.attach_function :g_array_new, [:int, :int, :uint], :pointer
         base::Lib.attach_function :g_array_append_vals,
           [:pointer, :pointer, :uint], :pointer
+
+        base::Lib.attach_function :g_main_loop_new,
+          [:pointer, :bool], :pointer
       end
 
       module ClassMethods
@@ -99,7 +106,7 @@ module GirFFI
 
         # FIXME: Turn into instance method
         def byte_array_append arr, data
-          bytes = GirFFI::ArgHelper.utf8_to_inptr data
+          bytes = GirFFI::InPointer.from :utf8, data
           len = data.bytesize
           ::GLib::ByteArray.wrap(::GLib::Lib.g_byte_array_append arr.to_ptr, bytes, len)
         end
@@ -115,7 +122,7 @@ module GirFFI
 
         # FIXME: Turn into instance method
         def array_append_vals arr, data
-          bytes = GirFFI::ArgHelper.typed_array_to_inptr arr.element_type, data
+          bytes = GirFFI::InPointer.from_array arr.element_type, data
           len = data.length
           res = ::GLib::Array.wrap(
             ::GLib::Lib.g_array_append_vals(arr.to_ptr, bytes, len))
@@ -123,6 +130,10 @@ module GirFFI
           res
         end
 
+        # FIXME: Turn into real constructor?
+        def main_loop_new context, is_running
+          ::GLib::MainLoop.wrap(::GLib::Lib.g_main_loop_new context, is_running)
+        end
       end
 
       module ListInstanceMethods
@@ -178,7 +189,7 @@ module GirFFI
 
         def cast_to_pointer type, it
           if type == :utf8
-            GirFFI::ArgHelper.utf8_to_inptr it
+            GirFFI::InPointer.from :utf8, it
           else
             FFI::Pointer.new(it)
           end

data/lib/gir_ffi/overrides/gobject.rb

@@ -105,7 +105,7 @@ module GirFFI
 	end
 
 	def signal_connect object, signal, data=nil, &block
-	  sig = object.class.gir_ffi_builder.find_signal signal
+	  sig = object.class._find_signal signal
 	  if sig.nil?
 	    raise "Signal #{signal} is invalid for #{object}"
 	  end
@@ -115,8 +115,7 @@ module GirFFI
 
 	  rettype = GirFFI::Builder.itypeinfo_to_ffitype sig.return_type
 
-          # FIXME: Why are these all pointers?
-	  argtypes = [:pointer] + sig.args.map {|arg| :pointer} + [:pointer]
+	  argtypes = GirFFI::Builder.ffi_argument_types_for_signal sig
 
 	  callback = FFI::Function.new rettype, argtypes,
 	    &(Helper.signal_callback_args(sig, object.class, &block))
@@ -129,6 +128,10 @@ module GirFFI
       end
 
       module Helper
+        TAG_TYPE_TO_GTYPE_NAME_MAP = {
+          :utf8 => "gchararray"
+        }
+
 	def self.signal_callback_args sig, klass, &block
 	  return Proc.new do |*args|
 	    mapped = cast_back_signal_arguments sig, klass, *args
@@ -137,7 +140,7 @@ module GirFFI
 	end
 
 	def self.signal_arguments_to_gvalue_array signal, instance, *rest
-	  sig = instance.class.gir_ffi_builder.find_signal signal
+	  sig = instance.class._find_signal signal
 
 	  arr = ::GObject::ValueArray.new sig.n_args+1
 
@@ -155,7 +158,10 @@ module GirFFI
 	end
 	
 	def self.signal_argument_to_gvalue info, arg
-	  if info.argument_type.tag == :interface
+          arg_type = info.argument_type
+          tag = arg_type.tag
+
+	  if tag == :interface
 	    interface = info.argument_type.interface
 
 	    val = ::GObject::Value.new
@@ -165,13 +171,17 @@ module GirFFI
 	      val.set_boxed arg
 	    when :object
 	      val.set_instance arg
+            when :enum
+              val.set_enum arg
 	    else
 	      raise NotImplementedError, interface.info_type
 	    end
 
 	    return val
 	  else
-	    raise NotImplementedError
+            val = ::GObject::Value.new
+            val.init ::GObject.type_from_name(TAG_TYPE_TO_GTYPE_NAME_MAP[tag])
+            val.set_ruby_value arg
 	  end
 	end
 
@@ -192,6 +202,7 @@ module GirFFI
 	  rval
 	end
 
+        # TODO: Generate cast back methods using existing Argument builders.
 	def self.cast_back_signal_arguments signalinfo, klass, *args
 	  result = []
 
@@ -202,14 +213,7 @@ module GirFFI
 
 	  # Extra arguments
 	  signalinfo.args.each do |info|
-	    arg = args.shift
-	    if info.argument_type.tag == :interface
-	      iface = info.argument_type.interface
-	      kls = GirFFI::Builder.build_class iface
-	      result << kls.wrap(arg)
-	    else
-	      result << arg
-	    end
+            result << cast_signal_argument(info, args.shift)
 	  end
 
 	  # User Data
@@ -227,6 +231,22 @@ module GirFFI
 
 	  return result
 	end
+
+        def self.cast_signal_argument info, arg
+          arg_t = info.argument_type
+          if arg_t.tag == :interface
+            iface = arg_t.interface
+            kls = GirFFI::Builder.build_class iface
+            case iface.info_type
+            when :enum, :flags
+              kls[arg]
+            else
+              kls.wrap(arg)
+            end
+          else
+            arg
+          end
+        end
       end
 
       module InitiallyUnownedClassMethods
@@ -252,6 +272,8 @@ module GirFFI
 	    set_boolean val
           when "gint"
 	    set_int val
+	  when "gchararray"
+	    set_string val
 	  else
 	    nil
 	  end
@@ -296,7 +318,7 @@ module GirFFI
 
       module ClosureInstanceMethods
         def set_marshal marshal
-	  _v1 = GirFFI::ArgHelper.wrap_in_callback_args_mapper(
+	  _v1 = GirFFI::CallbackHelper.wrap_in_callback_args_mapper(
             "GObject", "ClosureMarshal", marshal)
 	  ::GObject::Lib::CALLBACKS << _v1
 	  ::GObject::Lib.g_closure_set_marshal self, _v1

data/lib/gir_ffi/overrides/gtk.rb

@@ -3,7 +3,7 @@ module GirFFI
     module Gtk
 
       def self.included(base)
-	base.gir_ffi_builder.setup_function "init"
+	base._setup_method "init"
 	base.extend ClassMethods
 	base.class_eval do
 

data/lib/gir_ffi/version.rb

@@ -1,4 +1,4 @@
 module GirFFI
-  VERSION = "0.0.1"
+  VERSION = "0.0.11"
 end
 

data/lib/gir_ffi.rb

@@ -1,7 +1,10 @@
+require 'gir_ffi/g_object'
 require 'gir_ffi/i_repository'
 require 'gir_ffi/builder'
 
 module GirFFI
+  GObject.type_init
+
   def self.setup module_name, version=nil
     module_name = module_name.to_s
     GirFFI::Builder.build_module module_name, version

data/tasks/rdoc.rake

@@ -0,0 +1,6 @@
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean", :rerdoc => "rdoc:force") do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include "README.rdoc", "DESIGN.rdoc", "TODO.rdoc", "lib/**/*.rb"
+end

data/tasks/test.rake

@@ -2,9 +2,21 @@ require 'rake/testtask'
 
 namespace :test do
 
+  Rake::TestTask.new(:integration) do |t|
+    t.libs = ['lib']
+    t.test_files = FileList['test/integration/*_test.rb']
+    t.ruby_opts += ["-w"]
+  end
+
   Rake::TestTask.new(:run) do |t|
     t.libs = ['lib']
-    t.test_files = FileList['test/**/*_test.rb']
+    t.test_files = FileList['test/*_test.rb']
+    t.ruby_opts += ["-w"]
+  end
+
+  Rake::TestTask.new(:unit) do |t|
+    t.libs = ['lib']
+    t.test_files = FileList['test/unit/*_test.rb']
     t.ruby_opts += ["-w"]
   end
 
@@ -13,7 +25,14 @@ namespace :test do
     sh %{cd test/lib && make}
   end
 
+  task :integration => :lib
   task :run => :lib
+
+  desc 'Run rcov for the entire test suite'
+  task :coverage => :lib do
+    rm_f "coverage"
+    system "rcov", "-Ilib", "--exclude", "\.gem\/,\/gems\/", *FileList['test/**/*_test.rb']
+  end
 end
 
 file "test/lib/Makefile" => "test/lib/configure" do
@@ -24,5 +43,5 @@ file "test/lib/configure" do
   sh %{cd test/lib && NOCONFIGURE=1 ./autogen.sh}
 end
 
-desc 'Alias to test:run'
-task :test => 'test:run'
+desc 'Run unit an integration tests'
+task :test => ['test:unit', 'test:run', 'test:integration']

data/tasks/yardoc.rake

@@ -0,0 +1,6 @@
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = ['--private', '--protected', '--readme',  'README.rdoc', "--files", "DESIGN.rdoc,TODO.rdoc"]
+end

data/test/arg_helper_test.rb

@@ -1,54 +1,6 @@
 require File.expand_path('test_helper.rb', File.dirname(__FILE__))
 
 class ArgHelperTest < MiniTest::Spec
-  context "The gint32_to_inoutptr method's return value" do
-    setup do
-      @result = GirFFI::ArgHelper.gint32_to_inoutptr 24
-    end
-
-    should "be an FFI::Pointer" do
-      assert_instance_of FFI::Pointer, @result
-    end
-
-    should "hold a pointer to the correct input value" do
-      assert_equal 24, @result.read_int
-    end
-  end
-
-  context "The utf8_array_to_inoutptr method" do
-    context "when called with an array of strings" do
-      setup do
-	@result = GirFFI::ArgHelper.utf8_array_to_inoutptr ["foo", "bar", "baz"]
-      end
-
-      should "return an FFI::Pointer" do
-	assert_instance_of FFI::Pointer, @result
-      end
-
-      should "return a pointer to an array of pointers to strings" do
-	ptr = @result.read_pointer
-	ary = ptr.read_array_of_pointer(3)
-	assert_equal ["foo", "bar", "baz"], ary.map {|p| p.read_string}
-      end
-    end
-    context "when called with nil" do
-      should "return nil" do
-	assert_nil GirFFI::ArgHelper.utf8_array_to_inoutptr nil
-      end
-    end
-  end
-
-  context "The outptr_to_gint32 method" do
-    setup do
-      @ptr = GirFFI::AllocationHelper.safe_malloc FFI.type_size(:int)
-      @ptr.write_int 342
-    end
-
-    should "retrieve the correct integer value" do
-      assert_equal 342, GirFFI::ArgHelper.outptr_to_gint32(@ptr)
-    end
-  end
-
   context "The outptr_to_utf8_array method" do
     context "when called with a valid pointer to a string array" do
       setup do
@@ -88,7 +40,8 @@ class ArgHelperTest < MiniTest::Spec
 
     context "when called with a pointer to null" do
       should "return nil" do
-	ptr = GirFFI::ArgHelper.pointer_pointer.write_pointer nil
+	ptr = GirFFI::InOutPointer.for :pointer
+        assert ptr.read_pointer.null?
 	assert_nil GirFFI::ArgHelper.outptr_to_utf8_array(ptr, 0)
       end
     end
@@ -110,14 +63,6 @@ class ArgHelperTest < MiniTest::Spec
     end
   end
 
-  context "The pointer_outptr method" do
-    should "return a pointer to a null pointer" do
-      ptr = GirFFI::ArgHelper.pointer_outptr
-      pptr = ptr.read_pointer
-      assert pptr.null?
-    end
-  end
-
   context "The object_pointer_to_object method" do
     setup do
       GirFFI.setup :Regress
@@ -134,19 +79,4 @@ class ArgHelperTest < MiniTest::Spec
     end
   end
 
-  context "The map_single_callback_arg method" do
-    should "correctly map a :struct type" do
-      GirFFI.setup :GObject
-
-      cl = GObject::Closure.new_simple GObject::Closure::Struct.size, nil
-
-      cinfo = GirFFI::IRepository.default.find_by_name 'GObject', 'ClosureMarshal'
-      ainfo = cinfo.args[0]
-
-      r = GirFFI::ArgHelper.map_single_callback_arg cl.to_ptr, ainfo
-
-      assert_instance_of GObject::Closure, r
-      assert_equal r.to_ptr, cl.to_ptr
-    end
-  end
 end