gir_ffi 0.4.0 → 0.4.1

data/History.txt

@@ -1,3 +1,10 @@
+== 0.4.1 / 2012-09-18
+
+* Remove workarounds for older versions of gobject-introspection
+* Mark certain methods as deprecated. These will be removed in 0.5.0
+* Handle :filename type arguments in InPointer
+* Refactoring
+
 == 0.4.0 / 2012-08-24
 
 * Move Gtk+ bindings to their own gem (gir_ffi-gtk).

data/{README.rdoc → README.md}

@@ -1,16 +1,14 @@
-= GirFFI
+# GirFFI
 
 by Matijs van Zuijlen
 
-http://www.github.com/mvz/ruby-gir-ffi
+[![Build Status](https://secure.travis-ci.org/mvz/ruby-gir-ffi.png)](http://travis-ci.org/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
+## Description
 
 Ruby bindings for GNOME using the GObject Introspection Repository.
 
-== Features/Notes
+## Features/Notes
 
 * Create bindings to any GObject-based library.
 * Bindings generated at runtime.
@@ -18,40 +16,48 @@ Ruby bindings for GNOME using the GObject Introspection Repository.
 * Install 'gir_ffi-gtk' and require 'gir_ffi-gtk2' or 'gir_ffi-gtk3' to
   load overrides for Gtk2 or Gtk3.
 
-== Install
+## Usage
+
+    require 'gir_ffi'
 
-* sudo gem install gir_ffi
+    GirFFI.setup :TheNamespace
 
-== Synopsis
+    TheNamespace.some_function
 
-  require 'gir_ffi'
+    obj = TheNamespace::SomeClass.new
+    obj.some_method with, some, args
 
-  GirFFI.setup :TheNamespace
+## Install
 
-  TheNamespace.some_function
+    gem install gir_ffi
 
-  obj = TheNamespace::SomeClass.new
-  obj.some_method with, some, args
+## Requirements
 
-== Requirements
+GirFFI should work on MRI 1.8 and 1.9, and JRuby in both 1.8 and 1.9
+modes. It does not work on Rubinius yet.
 
-* Ruby-FFI of course
-* gobject-introspection installed with some introspection data
-* The `rr` and `minitest` gems for testing
+You will also need gobject-introspection installed with some
+introspection data.
 
 Depending on the GIR data, GirFFI needs the actual libraries to be
 available under the name ending in plain `.so`. If GirFFI complains that it
 cannot find the library, try installing development packages for those
 libraries.
 
+GirFFI is developed on Debian sid, and tested through Travis CI on Ubuntu
+12.04. Older versions of gobject-introspection than the ones used there
+are therefore not officially supported (although they may work).
+
 On Debian and Ubuntu, installing `libgirepository1.0-dev` and
-`gobject-introspection` (at least version 0.10) should be enough to get `rake
-test` working.
+`gobject-introspection` should be enough to get `rake test` working.
+
+GirFFI has not been tested on Mac OS X or Microsoft Windows. YMMV.
 
-== Hacking and contributing
+## Hacking and contributing
 
-If you want to help out, have a look at TODO.rdoc, and the output of `rake
-notes`. Feel free to file bugs or send pull requests.
+If you want to help out, have a look at TODO.rdoc, and check the notes
+in the code (e.g., using `dnote`). Feel free to file bugs or send pull
+requests.
 
 If you want to send pull requests or patches, please:
 
@@ -64,9 +70,9 @@ If you want to send pull requests or patches, please:
 * Try not to include changes that are irrelevant to your feature in the
   same commit.
 
-== License
+## License
 
-Copyright (c) 2009--2012 Matijs van Zuijlen
+Copyright &copy; 2009&ndash;2012 [Matijs van Zuijlen](http://www.matijs.net)
 
 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/Rakefile

@@ -1,3 +1,3 @@
 load 'tasks/setup.rb'
 
-task :default => 'test'
+task :default => 'test:all'

data/TODO.rdoc

@@ -33,4 +33,4 @@ implementation lagging behind the others.
 
 == See Also
 
-rake notes
+  dnote

data/lib/ffi-glib.rb

@@ -1,3 +1,6 @@
+# NOTE: Do not require this file directly. Require 'gir_ffi' instead.
+#
+
 GirFFI.setup :GLib
 
 require 'ffi-glib/s_list'
@@ -6,12 +9,11 @@ require 'ffi-glib/hash_table'
 require 'ffi-glib/byte_array'
 require 'ffi-glib/array'
 require 'ffi-glib/ptr_array'
-require 'ffi-glib/strv'
 
 module GLib
-  # FIXME: Remove eventually.
+  # @deprecated Compatibility function. Remove in version 0.5.0.
   def self.main_loop_new context, is_running
-    ::GLib::MainLoop.wrap(::GLib::Lib.g_main_loop_new context, is_running)
+    GLib::MainLoop.new context, is_running
   end
 
   load_class :HFunc
@@ -43,7 +45,5 @@ 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-glib/container_class_methods.rb

@@ -1,8 +1,7 @@
 module GLib
   module ContainerClassMethods
     def wrap typespec, ptr
-      super(ptr).tap do |it|
-        break if it.nil?
+      if (it = super(ptr))
         it.reset_typespec typespec
       end
     end

data/lib/ffi-glib/list_methods.rb

@@ -20,13 +20,10 @@ module GLib
     end
 
     def each
-      list = self
-      rval = nil
-      until list.nil?
-        rval = yield list.head
-        list = list.tail
+      reset_iterator
+      while (elem = next_element)
+        yield elem
       end
-      rval
     end
 
     def tail
@@ -41,6 +38,19 @@ module GLib
       self.element_type = typespec
       self
     end
+
+    private
+
+    def reset_iterator
+      @current = self
+    end
+
+    def next_element
+      return if @current.nil?
+      element = @current.head
+      @current = @current.tail
+      element
+    end
   end
 end
 

data/lib/ffi-gobject.rb

@@ -1,3 +1,6 @@
+# NOTE: Do not require this file directly. Require 'gir_ffi' instead.
+#
+
 GirFFI.setup :GObject
 
 require 'ffi-gobject/base'
@@ -34,7 +37,7 @@ module GObject
   def self.type_from_instance_pointer inst_ptr
     return nil if inst_ptr.null?
     klsptr = inst_ptr.get_pointer 0
-    klsptr.send "get_#{GirFFI::TypeMap::TAG_TYPE_MAP[:gtype]}", 0
+    klsptr.send "get_#{GirFFI::TypeMap::TAG_TYPE_MAP[:GType]}", 0
   end
 
   def self.type_from_instance instance
@@ -90,17 +93,11 @@ module GObject
   load_class :ParamFlags
 
   module Lib
-    attach_function :g_type_init, [], :void
     attach_function :g_object_ref, [:pointer], :void
     attach_function :g_object_ref_sink, [:pointer], :void
     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
 

data/lib/ffi-gobject/helper.rb

@@ -5,12 +5,12 @@ module GObject
     #
     # @param  klass   The class of the object that will receive the signal.
     # @param  signal  The name of the signal
-    # @param  &block  The body of the signal handler
+    # @param  block   The body of the signal handler
     #
-    # @returns [FFI::Function] The signal handler, ready to be passed as a
-    # callback to C.
+    # @return [FFI::Function] The signal handler, ready to be passed as a
+    #   callback to C.
     def self.signal_callback klass, signal, &block
-      sig_info = klass._find_signal signal
+      sig_info = klass.find_signal signal
 
       callback_block = signal_callback_args(sig_info, klass, &block)
 
@@ -35,7 +35,7 @@ module GObject
     end
 
     def self.signal_arguments_to_gvalue_array signal, instance, *rest
-      sig = instance.class._find_signal signal
+      sig = instance.class.find_signal signal
 
       arr = ::GObject::ValueArray.new sig.n_args + 1
 
@@ -75,7 +75,7 @@ module GObject
     end
 
     def self.gvalue_for_signal_return_value signal, object
-      sig = object.class._find_signal signal
+      sig = object.class.find_signal signal
       rettypeinfo = sig.return_type
 
       gvalue_for_type_info rettypeinfo

data/lib/ffi-gobject/object.rb

@@ -8,9 +8,9 @@ module GObject
 
     include RubyStyle
 
-    _setup_method "new"
-    _setup_instance_method "get_property"
-    _setup_instance_method "set_property"
+    setup_method "new"
+    setup_instance_method "get_property"
+    setup_instance_method "set_property"
 
     def get_property_with_override property_name
       type = get_property_type property_name
@@ -39,7 +39,7 @@ module GObject
     private
 
     def get_property_type property_name
-      prop = self.class._find_property property_name
+      prop = self.class.find_property property_name
       prop.property_type
     end
 

data/lib/ffi-gobject_introspection.rb

@@ -1,3 +1,2 @@
-require 'ffi'
 require 'ffi-gobject_introspection/i_repository'
 

data/lib/ffi-gobject_introspection/g_error.rb

@@ -1,8 +1,18 @@
 module GObjectIntrospection
-  # Wraps GObject's GError struct.
-  class GError < FFI::Struct
-    layout :domain, :uint32,
-      :code, :int,
-      :message, :string
+  # Wraps GLib's GError struct.
+  class GError
+    class Struct < FFI::Struct
+      layout :domain, :uint32,
+        :code, :int,
+        :message, :string
+    end
+
+    def initialize ptr
+      @struct = self.class::Struct.new(ptr)
+    end
+
+    def message
+      @struct[:message]
+    end
   end
 end

data/lib/ffi-gobject_introspection/i_base_info.rb

@@ -38,10 +38,13 @@ module GObjectIntrospection
     end
 
     def safe_name
-      if name =~ /^_/
-        "Private__" + name
-      else
-        name.gsub(/^(.)/) { $1.upcase }
+      name.gsub(/^./) do |char|
+        case char
+        when "_"
+          "Private___"
+        else
+          char.upcase
+        end
       end
     end
 

data/lib/ffi-gobject_introspection/i_function_info.rb

@@ -30,7 +30,9 @@ module GObjectIntrospection
     end
 
     def safe_name
-      name == '' ? '_' : name
+      name = self.name
+      return "_" if name.empty?
+      name
     end
   end
 end

data/lib/ffi-gobject_introspection/i_repository.rb

@@ -1,6 +1,8 @@
 require 'singleton'
+require 'ffi'
+require 'gir_ffi-base'
+
 require 'ffi-gobject_introspection/lib'
-require 'ffi-gobject_introspection/gobject_lib'
 require 'ffi-gobject_introspection/g_error'
 require 'ffi-gobject_introspection/i_base_info'
 require 'ffi-gobject_introspection/i_callable_info'
@@ -21,7 +23,7 @@ require 'ffi-gobject_introspection/i_enum_info'
 require 'ffi-gobject_introspection/i_flags_info'
 
 module GObjectIntrospection
-  GObjectLib::g_type_init
+  GObject::Lib::g_type_init
 
   # The Gobject Introspection Repository. This class is the point of
   # access to the introspection typelibs.
@@ -78,7 +80,7 @@ module GObjectIntrospection
       Lib.g_irepository_require @gobj, namespace, version, flags, errpp
 
       errp = errpp.read_pointer
-      raise GError.new(errp)[:message] unless errp.null?
+      raise GError.new(errp).message unless errp.null?
     end
 
     def n_infos namespace
@@ -108,8 +110,9 @@ module GObjectIntrospection
     end
 
     def dependencies namespace
-      strv = Lib.g_irepository_get_dependencies @gobj, namespace
-      strv_to_utf8_array strv
+      strv_p = Lib.g_irepository_get_dependencies(@gobj, namespace)
+      strv = GLib::Strv.new strv_p
+      strv.to_a
     end
 
     def shared_library namespace
@@ -130,15 +133,5 @@ module GObjectIntrospection
     def wrap ptr
       IRepository.wrap_ibaseinfo_pointer ptr
     end
-
-    def strv_to_utf8_array strv
-      return [] if strv.null?
-      arr, offset = [], 0
-      until (ptr = strv.get_pointer offset).null? do
-        arr << ptr.read_string
-        offset += POINTER_SIZE
-      end
-      return arr
-    end
   end
 end

data/lib/ffi-gobject_introspection/i_struct_info.rb

@@ -23,8 +23,11 @@ module GObjectIntrospection
     build_array_method :get_methods
 
     def find_method(name)
-      @methods_hash ||= make_method_hash
-      @methods_hash[name]
+      method_map[name]
+    end
+
+    def method_map
+      @method_map ||= Hash[get_methods.map {|mthd| [mthd.name, mthd] }]
     end
 
     def size
@@ -38,13 +41,5 @@ module GObjectIntrospection
     def gtype_struct?
       Lib.g_struct_info_is_gtype_struct @gobj
     end
-
-    private
-
-    def make_method_hash
-      Hash.new.tap do |hash|
-        get_methods.each {|mth| hash[mth.name] = mth }
-      end
-    end
   end
 end

data/lib/gir_ffi-base.rb

@@ -0,0 +1,2 @@
+require 'gir_ffi-base/glib/strv'
+require 'gir_ffi-base/gobject/lib'

data/lib/gir_ffi-base/glib/strv.rb

@@ -0,0 +1,43 @@
+require 'ffi'
+
+module GLib
+  # Represents a null-terminated array of strings. GLib uses this
+  # construction, but does not provide any actual functions for this class.
+  class Strv
+    include Enumerable
+
+    POINTER_SIZE = FFI.type_size(:pointer)
+
+    def initialize ptr
+      @ptr = ptr
+    end
+
+    def to_ptr
+      @ptr
+    end
+
+    def each
+      reset_iterator or return
+      while (ptr = next_ptr)
+        yield ptr.read_string
+      end
+    end
+
+    def self.wrap ptr
+      self.new ptr
+    end
+
+    private
+
+    def reset_iterator
+      return if @ptr.null?
+      @offset = 0
+    end
+
+    def next_ptr
+      ptr = @ptr.get_pointer @offset
+      @offset += POINTER_SIZE
+      ptr unless ptr.null?
+    end
+  end
+end