gir_ffi 0.0.7 → 0.0.8

data/History.txt

@@ -1,3 +1,12 @@
+== 0.0.8 / 2011-04-08
+
+* Generate modules with names starting with a lowercase letter (like
+  cairo).
+* Allow specifying the typelib version on setup.
+* Rename methods #methods and #type of the introspection classes to avoid
+  clashing with standard Ruby methods.
+* Refactoring.
+
 == 0.0.7 / 2011-04-01
 
 * Support gobject-introspection 0.10, drop support for earlier versions.

data/README.rdoc

@@ -25,26 +25,22 @@ Ruby-FFI-based binding of the GObject Introspection Repository
 
 * Ruby-FFI of course
 * gobject-introspection installed with some introspection data
+* The `rr` and `shoulda` gems for testing.
 
 The current implementation needs the actual libraries to be available under
 the name ending in just `.so`. On Debian and Ubuntu at least, this means
 you have to install the -dev packages of any library you may want to
-access.
-
-On Ubuntu, the following set of packages should do the trick:
-`libffi-ruby`, `libgirepository1.0-dev`, `libgtk2.0-dev`,
-`libshoulda-ruby`, `gir1.0-everything-1.0`.
-
-On Debian it's the same, but the `gir1.0-everything-1.0` package is only
-available in experimental. You can take one of the patches attached to bug
-550478 and recompile `gobject-introspection` to get the files GirFFI needs.
+access. The following set of packages should do the trick:
+`libgirepository1.0-dev` (at least version 0.10), and either
+`gir1.2-gtk-3.0` and `libgtk-3-dev`, or `gir1.2-gtk-2.0` and
+`libgtk2.0-dev`.
 
 == Hacking
 
 This is still very much a work in progress. You can start exploring by
 running the example programs in the examples/ folder. Some illustrate what
 works, some are a test bed for how things should work. Have a look at
-+rake+ +-T+.
+`rake -T`. Feel free to file bugs or send pull requests.
 
 == Install
 
@@ -52,7 +48,7 @@ works, some are a test bed for how things should work. Have a look at
 
 == License
 
-Copyright (c) 2009--2010 Matijs van Zuijlen
+Copyright (c) 2009--2011 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/01_empty_window.rb

@@ -5,8 +5,8 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'gir_ffi'
 
+GirFFI.setup :Gtk, '2.0'
 GirFFI.setup :GObject
-GirFFI.setup :Gtk
 
 Gtk.init
 win = Gtk::Window.new :toplevel

data/examples/02_hello_world.rb

@@ -5,8 +5,8 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'gir_ffi'
 
+GirFFI.setup :Gtk, '2.0'
 GirFFI.setup :GObject
-GirFFI.setup :Gtk
 
 Gtk.init
 

data/examples/03_upgraded_hello_world.rb

@@ -5,8 +5,8 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'gir_ffi'
 
+GirFFI.setup :Gtk, '2.0'
 GirFFI.setup :GObject
-GirFFI.setup :Gtk
 
 callback = lambda { |widget, data|
   puts "Hello again - #{data} was pressed"

data/examples/04_webkit.rb

@@ -2,8 +2,8 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'gir_ffi'
 
-GirFFI.setup :Gtk
-GirFFI.setup :WebKit
+GirFFI.setup :Gtk, '2.0'
+GirFFI.setup :WebKit, '1.0'
 
 Gtk.init
 

data/lib/gir_ffi/arg_helper.rb

@@ -4,7 +4,6 @@ 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)
@@ -74,26 +73,22 @@ module GirFFI
     end
 
     def self.cleanup_ptr_ptr ptr
-      block = ptr.read_pointer
+      LibC.free ptr.read_pointer
       LibC.free ptr
-      LibC.free block
     end
 
     # Takes an outptr to a pointer array, and frees all pointers.
     def self.cleanup_ptr_array_ptr ptr, size
       block = ptr.read_pointer
+      unless block.null?
+        block.read_array_of_pointer(size).each { |pt| LibC.free pt }
+        LibC.free block
+      end
       LibC.free ptr
-
-      return if block.null?
-
-      ptrs = block.read_array_of_pointer(size)
-      LibC.free block
-
-      ptrs.each { |ptr| LibC.free ptr }
     end
 
     def self.int32_to_inoutptr val
-      int32_pointer.write_int32 val
+      int32_pointer.put_int32 0, val
     end
 
     def self.utf8_to_inoutptr str
@@ -148,7 +143,7 @@ module GirFFI
     end
 
     def self.int32_outptr
-      int32_pointer.write_int32 0
+      int32_pointer.put_int32 0, 0
     end
 
     def self.double_outptr
@@ -176,7 +171,7 @@ module GirFFI
 
     # Converts an outptr to an int.
     def self.outptr_to_int32 ptr
-      ptr.read_int32
+      ptr.get_int32 0
     end
 
     # Converts an outptr to a string.
@@ -214,7 +209,7 @@ module GirFFI
     end
 
     def self.ptr_to_int32_array ptr, size
-      ptr.read_array_of_int32(size)
+      ptr.get_array_of_int32(0, size)
     end
 
     def self.ptr_to_utf8 ptr
@@ -273,7 +268,7 @@ module GirFFI
     end
 
     def self.map_single_callback_arg arg, info
-      case info.type.tag
+      case info.argument_type.tag
       when :interface
         map_interface_callback_arg arg, info
       when :utf8
@@ -286,8 +281,8 @@ module GirFFI
     end
 
     def self.map_interface_callback_arg arg, info
-      iface = info.type.interface
-      case iface.type
+      iface = info.argument_type.interface
+      case iface.info_type
       when :object
         object_pointer_to_object arg
       when :struct
@@ -331,12 +326,6 @@ module GirFFI
       return nil if optr.null?
       tp = ::GObject.type_from_instance_pointer optr
       info = gir.find_by_gtype tp
-
-      if info.nil?
-	tpname = ::GObject.type_name tp
-	raise RuntimeError, "Unable to find info for type '#{tpname}' (#{tp})"
-      end
-
       klass = GirFFI::Builder.build_class info
       klass.wrap optr
     end

data/lib/gir_ffi/builder/argument.rb

@@ -13,7 +13,7 @@ module GirFFI::Builder
 
     attr_reader :callarg, :name, :retname
 
-    attr_accessor :length_arg, :length_arg_for
+    attr_accessor :length_arg, :array_arg
 
     def initialize function_builder, arginfo=nil, libmodule=nil
       @arginfo = arginfo
@@ -24,7 +24,7 @@ module GirFFI::Builder
       @function_builder = function_builder
       @libmodule = libmodule
       @length_arg = nil
-      @length_arg_for = nil
+      @array_arg = nil
     end
 
     def self.build function_builder, arginfo, libmodule
@@ -41,8 +41,44 @@ module GirFFI::Builder
       klass.build function_builder, arginfo, libmodule
     end
 
-    def type
-      @arginfo.type
+    def type_info
+      @arginfo.argument_type
+    end
+
+    def type_tag
+      type_info.tag
+    end
+
+    def subtype_tag
+      st = type_info.param_type(0)
+      t = st.tag
+      case t
+      when :GType
+        return :gtype
+      when :interface
+        raise NotImplementedError if st.pointer?
+        iface = st.interface
+        if iface.name == 'Value' and iface.namespace == 'GObject'
+          return :gvalue
+        else
+          raise NotImplementedError
+        end
+      else
+        return t
+      end
+    end
+
+    def argument_class_name
+      iface = type_info.interface
+      "::#{iface.namespace}::#{iface.name}"
+    end
+
+    def array_size
+      if @length_arg
+        @length_arg.retname
+      else
+        type_info.array_fixed_size
+      end
     end
 
     def safe name
@@ -54,11 +90,11 @@ module GirFFI::Builder
     end
 
     def inarg
-      @length_arg_for.nil? ? @inarg : nil
+      @array_arg.nil? ? @inarg : nil
     end
 
     def retval
-      @length_arg_for.nil? ? @retname : nil
+      @array_arg.nil? ? @retname : nil
     end
 
     def pre
@@ -83,10 +119,10 @@ module GirFFI::Builder
     end
 
     def self.build function_builder, arginfo, libmodule
-      type = arginfo.type
+      type = arginfo.argument_type
       klass = case type.tag
               when :interface
-                if type.interface.type == :callback
+                if type.interface.info_type == :callback
                   CallbackInArgument
                 else
                   RegularInArgument
@@ -110,7 +146,7 @@ module GirFFI::Builder
   # :in.
   class CallbackInArgument < InArgument
     def pre
-      iface = @arginfo.type.interface
+      iface = type_info.interface
       [ "#{@callarg} = GirFFI::ArgHelper.wrap_in_callback_args_mapper \"#{iface.namespace}\", \"#{iface.name}\", #{@name}",
         "::#{@libmodule}::CALLBACKS << #{@callarg}" ]
     end
@@ -126,24 +162,6 @@ module GirFFI::Builder
 
   # Implements argument processing for array arguments with direction :in.
   class ArrayInArgument < InArgument
-    def subtype_tag
-      st = @arginfo.type.param_type(0)
-      t = st.tag
-      case t
-      when :GType : return :gtype
-      when :interface
-        raise NotImplementedError if st.pointer?
-        iface = st.interface
-        if iface.name == 'Value' and iface.namespace == 'GObject'
-          return :gvalue
-        else
-          raise NotImplementedError
-        end
-      else
-        return t
-      end
-    end
-
     def post
       unless @arginfo.ownership_transfer == :everything
         if subtype_tag == :utf8
@@ -156,7 +174,7 @@ module GirFFI::Builder
 
     def pre
       pr = []
-      size = type.array_fixed_size
+      size = type_info.array_fixed_size
       if size > -1
         pr << "GirFFI::ArgHelper.check_fixed_array_size #{size}, #{@name}, \"#{@name}\""
       end
@@ -167,20 +185,8 @@ module GirFFI::Builder
 
   # Implements argument processing for gslist arguments with direction :in.
   class ListInArgument < InArgument
-    def subtype_tag
-      @arginfo.type.param_type(0).tag
-    end
-
-    def type_tag
-      @arginfo.type.tag
-    end
-
     def pre
-      if subtype_tag == :void
-        [ "#{@callarg} = #{@name}" ]
-      else
-        [ "#{@callarg} = GirFFI::ArgHelper.#{subtype_tag}_array_to_#{type_tag} #{@name}" ]
-      end
+      [ "#{@callarg} = GirFFI::ArgHelper.#{subtype_tag}_array_to_#{type_tag} #{@name}" ]
     end
   end
 
@@ -204,8 +210,9 @@ module GirFFI::Builder
   class RegularInArgument < InArgument
     def pre
       pr = []
-      if @length_arg_for
-	pr << "#{@name} = #{@length_arg_for.name}.nil? ? 0 : #{@length_arg_for.name}.length"
+      if @array_arg
+        arrname = @array_arg.name
+	pr << "#{@name} = #{arrname}.nil? ? 0 : #{arrname}.length"
       end
       pr << "#{@callarg} = #{@name}"
       pr
@@ -221,7 +228,7 @@ module GirFFI::Builder
     end
 
     def self.build function_builder, arginfo, libmodule
-      klass = case arginfo.type.tag
+      klass = case arginfo.argument_type.tag
               when :interface
                 InterfaceOutArgument
               when :array
@@ -238,14 +245,9 @@ module GirFFI::Builder
   # Implements argument processing for interface arguments with direction
   # :out (structs, objects, etc.).
   class InterfaceOutArgument < OutArgument
-    def klass
-      iface = @arginfo.type.interface
-      "#{iface.namespace}::#{iface.name}"
-    end
-
     def pre
       if @arginfo.caller_allocates?
-	[ "#{@callarg} = #{klass}.allocate" ]
+	[ "#{@callarg} = #{argument_class_name}.allocate" ]
       else
 	[ "#{@callarg} = GirFFI::ArgHelper.pointer_outptr" ]
       end
@@ -255,7 +257,7 @@ module GirFFI::Builder
       if @arginfo.caller_allocates?
 	[ "#{@retname} = #{@callarg}" ]
       else
-	[ "#{@retname} = #{klass}.wrap GirFFI::ArgHelper.outptr_to_pointer(#{@callarg})" ]
+	[ "#{@retname} = #{argument_class_name}.wrap GirFFI::ArgHelper.outptr_to_pointer(#{@callarg})" ]
       end
     end
   end
@@ -268,15 +270,8 @@ module GirFFI::Builder
     end
 
     def postpost
-      type = @arginfo.type
-
-      size = if @length_arg
-               @length_arg.retname
-             else
-               type.array_fixed_size
-             end
-
-      tag = type.param_type(0).tag
+      size = array_size
+      tag = subtype_tag
 
       pp = [ "#{@retname} = GirFFI::ArgHelper.outptr_to_#{tag}_array #{@callarg}, #{size}" ]
 
@@ -300,22 +295,12 @@ module GirFFI::Builder
     end
 
     def postpost
-      type = @arginfo.type
-
-      tag = type.param_type(0).tag
-
-      pp = [ "#{@retname} = GirFFI::ArgHelper.outgslist_to_#{tag}_array #{@callarg}" ]
-
-      pp
+      [ "#{@retname} = GirFFI::ArgHelper.outgslist_to_#{subtype_tag}_array #{@callarg}" ]
     end
   end
   # Implements argument processing for arguments with direction
   # :out that are neither arrays nor 'interfaces'.
   class RegularOutArgument < OutArgument
-    def type_tag
-      @arginfo.type.tag
-    end
-
     def post
       pst = [ "#{@retname} = GirFFI::ArgHelper.outptr_to_#{type_tag} #{@callarg}" ]
       if @arginfo.ownership_transfer == :everything
@@ -341,7 +326,7 @@ module GirFFI::Builder
     def self.build function_builder, arginfo, libmodule
       raise NotImplementedError unless arginfo.ownership_transfer == :everything
 
-      klass = case arginfo.type.tag
+      klass = case arginfo.argument_type.tag
               when :interface
                 raise NotImplementedError
               when :array
@@ -357,10 +342,6 @@ module GirFFI::Builder
   # Implements argument processing for array arguments with direction
   # :inout.
   class ArrayInOutArgument < InOutArgument
-    def subtype_tag
-      @arginfo.type.param_type(0).tag
-    end
-
     def pre
       [ "#{@callarg} = GirFFI::ArgHelper.#{subtype_tag}_array_to_inoutptr #{@name}" ]
     end
@@ -381,10 +362,6 @@ module GirFFI::Builder
   # Implements argument processing for arguments with direction
   # :inout that are neither arrays nor 'interfaces'.
   class RegularInOutArgument < InOutArgument
-    def type_tag
-      @arginfo.type.tag
-    end
-
     def post
       [ "#{@retname} = GirFFI::ArgHelper.outptr_to_#{type_tag} #{@callarg}",
         "GirFFI::ArgHelper.cleanup_ptr #{@callarg}" ]
@@ -392,8 +369,8 @@ module GirFFI::Builder
 
     def pre
       pr = []
-      if @length_arg_for
-        pr << "#{@name} = #{@length_arg_for.name}.length"
+      if @array_arg
+        pr << "#{@name} = #{@array_arg.name}.length"
       end
       pr << "#{@callarg} = GirFFI::ArgHelper.#{type_tag}_to_inoutptr #{@name}"
       pr
@@ -409,7 +386,7 @@ module GirFFI::Builder
       @retname = @function_builder.new_var
     end
 
-    def type
+    def type_info
       @arginfo.return_type
     end
 
@@ -419,7 +396,7 @@ module GirFFI::Builder
               when :void
                 VoidReturnValue
               when :interface
-                case type.interface.type
+                case type.interface.info_type
                 when :interface, :struct
                   InterfaceReturnValue
                 when :object
@@ -456,12 +433,7 @@ module GirFFI::Builder
   # polymorphism and constructors.
   class InterfaceReturnValue < ReturnValue
     def post
-      interface = @arginfo.return_type.interface
-      namespace = interface.namespace
-      name = interface.name
-
-      GirFFI::Builder.build_class interface
-      [ "#{@retname} = ::#{namespace}::#{name}.wrap(#{@cvar})" ]
+      [ "#{@retname} = #{argument_class_name}.wrap(#{@cvar})" ]
     end
   end
 
@@ -474,50 +446,29 @@ module GirFFI::Builder
 
   # Implements argument processing for object constructors.
   class ConstructorReturnValue < ReturnValue
-    def post
+    def defining_class_name
       classinfo = @arginfo.container
-      namespace = classinfo.namespace
-      name = classinfo.name
+      "::#{classinfo.namespace}::#{classinfo.name}"
+    end
 
-      GirFFI::Builder.build_class classinfo
-      [ "#{@retname} = ::#{namespace}::#{name}.constructor_wrap(#{@cvar})" ]
+    def post
+      [ "#{@retname} = #{defining_class_name}.constructor_wrap(#{@cvar})" ]
     end
   end
 
   # Implements argument processing for array return values.
   class ArrayReturnValue < ReturnValue
-    def subtype_tag
-      @arginfo.return_type.param_type(0).tag
-    end
-
     def post
-      type = @arginfo.return_type
-      size = type.array_fixed_size
+      size = array_size
 
-      if size <= 0
-	size = @length_arg.retname
-      end
       [ "#{@retname} = GirFFI::ArgHelper.ptr_to_#{subtype_tag}_array #{@cvar}, #{size}" ]
     end
   end
 
   # Implements argument processing for GSList return values.
   class ListReturnValue < ReturnValue
-    # TODO: Extract to a module.
-    def subtype_tag
-      @arginfo.return_type.param_type(0).tag
-    end
-
-    def type_tag
-      @arginfo.return_type.tag
-    end
-
     def post
-      if subtype_tag == :void
-        [ "#{@retname} = ::GLib::SList.wrap(#{@cvar})" ]
-      else
-        [ "#{@retname} = GirFFI::ArgHelper.#{type_tag}_to_#{subtype_tag}_array #{@cvar}" ]
-      end
+      [ "#{@retname} = GirFFI::ArgHelper.#{type_tag}_to_#{subtype_tag}_array #{@cvar}" ]
     end
   end
 

data/lib/gir_ffi/builder/function.rb

@@ -18,10 +18,10 @@ module GirFFI::Builder
 
       alldata.each {|data|
         data.prepare
-	idx = data.type.array_length
+	idx = data.type_info.array_length
         if idx > -1
           data.length_arg = @data[idx] 
-          @data[idx].length_arg_for = data
+          @data[idx].array_arg = data
         end
       }
 

data/lib/gir_ffi/builder/module.rb

@@ -7,8 +7,10 @@ module GirFFI
   class Builder::Module
     include BuilderHelper
 
-    def initialize namespace
+    def initialize namespace, version=nil
       @namespace = namespace
+      @version = version
+      @safe_namespace = @namespace.gsub(/^(.)/) { $1.upcase }
     end
 
     def generate
@@ -48,7 +50,7 @@ module GirFFI
     end
 
     def instantiate_module
-      @module = get_or_define_module ::Object, @namespace.to_s
+      @module = get_or_define_module ::Object, @safe_namespace
     end
 
     def setup_module
@@ -81,7 +83,7 @@ module GirFFI
     def function_introspection_data function
       info = gir.find_by_name @namespace, function.to_s
 
-      if info.type == :function
+      if info.info_type == :function
         info
       else
         nil
@@ -95,7 +97,7 @@ module GirFFI
     def gir
       unless defined? @gir
         @gir = IRepository.default
-        @gir.require @namespace, nil
+        @gir.require @namespace, @version
       end
       @gir
     end

data/lib/gir_ffi/builder/type/base.rb

@@ -0,0 +1,35 @@
+module GirFFI
+  module Builder
+    module Type
+      class Base
+        include BuilderHelper
+
+        def initialize info
+          @info = info
+          @namespace = @info.namespace
+          @classname = @info.name.gsub(/^(.)/) { $1.upcase }
+        end
+
+        private
+
+        def info
+          @info
+        end
+
+        def namespace_module
+          @namespace_module ||= Builder.build_module @namespace
+        end
+
+        def lib
+          @lib ||= namespace_module.const_get :Lib
+        end
+
+        def get_or_define_class namespace, name, parent
+          optionally_define_constant(namespace, name) {
+            Class.new parent
+          }
+        end
+      end
+    end
+  end
+end

data/lib/gir_ffi/builder/type/callback.rb

@@ -0,0 +1,27 @@
+require 'gir_ffi/builder/type/base'
+module GirFFI
+  module Builder
+    module Type
+
+      # Implements the creation of a callback type. The type will be
+      # attached to the appropriate namespace module, and will be defined
+      # as a callback for FFI.
+      class Callback < Base
+        def build_class
+          unless defined? @klass
+            instantiate_callback_class
+          end
+          @klass
+        end
+
+        def instantiate_callback_class
+          @klass = optionally_define_constant namespace_module, @classname do
+            args = Builder.ffi_function_argument_types info
+            ret = Builder.ffi_function_return_type info
+            lib.callback @classname.to_sym, args, ret
+          end
+        end
+      end
+    end
+  end
+end