gir_ffi 0.4.3 → 0.5.0

data/lib/gir_ffi/in_pointer.rb

@@ -19,7 +19,7 @@ module GirFFI
       return nil if val.nil?
       case type
       when Array
-        arr_t, sub_t = *type
+        _, sub_t = *type
         # TODO: Take array type into account (zero-terminated or not)
         self.from_array sub_t, val
       when :utf8, :filename

data/lib/gir_ffi/info_ext.rb

@@ -0,0 +1,6 @@
+require 'gir_ffi/info_ext/safe_constant_name'
+require 'gir_ffi/info_ext/safe_function_name'
+require 'gir_ffi/info_ext/i_field_info'
+require 'gir_ffi/info_ext/i_property_info'
+require 'gir_ffi/info_ext/i_registered_type_info'
+require 'gir_ffi/info_ext/i_type_info'

data/lib/gir_ffi/info_ext/i_field_info.rb

@@ -1,5 +1,3 @@
-require 'gir_ffi/info_ext/i_type_info'
-
 module GirFFI
   module InfoExt
     module IFieldInfo

data/lib/gir_ffi/info_ext/i_type_info.rb

@@ -40,9 +40,10 @@ module GirFFI
       end
 
       def type_specification
-        tag = self.tag
-        if tag == :array
-          "[#{flattened_array_type.inspect}, #{element_type.inspect}]"
+        tag = self.flattened_tag
+        case tag
+        when :strv, :zero_terminated, :c
+          "[#{tag.inspect}, #{subtype_tag_or_class_name}]"
         else
           tag.inspect
         end
@@ -65,20 +66,38 @@ module GirFFI
 
       def flattened_array_type
         if zero_terminated?
-          if element_type == :utf8
-            :strv
-          else
-            # TODO: Check that array_type == :c
-            # TODO: Perhaps distinguish :c from zero-terminated :c
-            :c
-          end
+          zero_terminated_array_type
         else
           array_type
         end
       end
 
+      def subtype_tag_or_class_name
+        type = self.param_type 0
+        tag = type.tag
+        base = if tag == :interface
+                 type.interface_type_name
+               else
+                 tag.inspect
+               end
+        if type.pointer? && tag != :utf8
+          "[:pointer, #{base}]"
+        else
+          base
+        end
+      end
+
       private
 
+      def zero_terminated_array_type
+        if element_type == :utf8
+          :strv
+        else
+          # TODO: Check that array_type == :c
+          :zero_terminated
+        end
+      end
+
       def subtype_tag index
         st = param_type(index)
         tag = st.tag

data/lib/gir_ffi/info_ext/safe_constant_name.rb

@@ -0,0 +1,21 @@
+module GirFFI
+  module InfoExt
+    module SafeConstantName
+      def safe_name
+        name.gsub(/^./) do |char|
+          case char
+          when "_"
+            "Private___"
+          else
+            char.upcase
+          end
+        end
+      end
+    end
+  end
+end
+
+GObjectIntrospection::IRegisteredTypeInfo.send :include, GirFFI::InfoExt::SafeConstantName
+GObjectIntrospection::ICallbackInfo.send :include, GirFFI::InfoExt::SafeConstantName
+GObjectIntrospection::IConstantInfo.send :include, GirFFI::InfoExt::SafeConstantName
+

data/lib/gir_ffi/info_ext/safe_function_name.rb

@@ -0,0 +1,13 @@
+module GirFFI
+  module InfoExt
+    module SafeFunctionName
+      def safe_name
+        name = self.name
+        return "_" if name.empty?
+        name
+      end
+    end
+  end
+end
+
+GObjectIntrospection::IFunctionInfo.send :include, GirFFI::InfoExt::SafeFunctionName

data/lib/gir_ffi/interface_base.rb

@@ -1,21 +1,11 @@
 module GirFFI
   module InterfaceBase
-    # @deprecated Compatibility function. Remove in version 0.5.0.
-    def _builder
-      gir_ffi_builder
-    end
-
     def gir_ffi_builder
       self.const_get :GIR_FFI_BUILDER
     end
 
-    # @deprecated Compatibility function. Remove in version 0.5.0.
-    def _setup_instance_method name
-      setup_instance_method name
-    end
-
     def setup_instance_method name
-      _builder.setup_instance_method name
+      gir_ffi_builder.setup_instance_method name
     end
 
     def wrap ptr

data/lib/gir_ffi/module_base.rb

@@ -16,20 +16,10 @@ module GirFFI
       gir_ffi_builder.build_namespaced_class classname.to_s
     end
 
-    # @deprecated Compatibility function. Remove in version 0.5.0.
-    def _builder
-      gir_ffi_builder
-    end
-
     def gir_ffi_builder
       self.const_get :GIR_FFI_BUILDER
     end
 
-    # @deprecated Compatibility function. Remove in version 0.5.0.
-    def _setup_method name
-      setup_method name
-    end
-
     def setup_method name
       gir_ffi_builder.setup_method name
     end

data/lib/gir_ffi/null_argument_builder.rb

@@ -0,0 +1,9 @@
+module GirFFI
+  # Argument builder that does nothing. Implements the Null Object pattern.
+  class NullArgumentBuilder
+    def initialize *args; end
+    def pre; []; end
+    def post; []; end
+    def callarg; end
+  end
+end

data/lib/gir_ffi/return_value_builder.rb

@@ -0,0 +1,75 @@
+require 'gir_ffi/base_argument_builder'
+
+module GirFFI
+  # Implements building post-processing statements for return values.
+  class ReturnValueBuilder < BaseArgumentBuilder
+    def initialize var_gen, type_info, is_constructor
+      super var_gen, nil, type_info, :return
+      @is_constructor = is_constructor
+    end
+
+    def post
+      if needs_wrapping?
+        if specialized_type_tag == :zero_terminated
+          # FIXME: This is almost certainly wrong.
+          [ "#{retname} = #{argument_class_name}.wrap(#{cvar})" ]
+        elsif [ :interface, :object ].include?(specialized_type_tag) && @is_constructor
+          [ "#{retname} = self.constructor_wrap(#{cvar})" ]
+        else
+          [ "#{retname} = #{argument_class_name}.wrap(#{return_value_conversion_arguments})" ]
+        end
+      elsif specialized_type_tag == :utf8
+        # TODO: Re-use methods in InOutPointer for this conversion
+        [ "#{retname} = GirFFI::ArgHelper.ptr_to_utf8(#{cvar})" ]
+      elsif specialized_type_tag == :c
+        size = array_size
+        [ "#{retname} = GirFFI::ArgHelper.ptr_to_typed_array #{subtype_tag_or_class_name}, #{cvar}, #{size}" ]
+      else
+        []
+      end
+    end
+
+    def inarg
+      nil
+    end
+
+    # TODO: Rename
+    def cvar
+      callarg unless is_void_return_value?
+    end
+
+    def retval
+      if has_conversion?
+        super
+      elsif is_void_return_value?
+        nil
+      else
+        callarg
+      end
+    end
+
+    private
+
+    def retname
+      @retname ||= @var_gen.new_var
+    end
+
+    def has_conversion?
+      needs_wrapping? || [ :utf8, :c ].include?(specialized_type_tag)
+    end
+
+    def needs_wrapping?
+      [ :struct, :union, :interface, :object, :strv, :zero_terminated,
+        :byte_array, :ptr_array, :glist, :gslist, :ghash, :array
+      ].include?(specialized_type_tag)
+    end
+
+    def is_void_return_value?
+      specialized_type_tag == :void && !type_info.pointer?
+    end
+
+    def return_value_conversion_arguments
+      conversion_arguments cvar
+    end
+  end
+end

data/lib/gir_ffi/setter_argument_info.rb

@@ -0,0 +1,16 @@
+module GirFFI
+  # Class to represent argument info for the argument of a setter method.
+  # Implements the necessary parts of IArgumentInfo's interface.
+  class SetterArgumentInfo
+    attr_reader :name, :argument_type
+
+    def initialize name, type
+      @name = name
+      @argument_type = type
+    end
+
+    def direction
+      :in
+    end
+  end
+end

data/lib/gir_ffi/type_map.rb

@@ -4,6 +4,15 @@ module GirFFI
     gtype_type = "uint#{sz}".to_sym
 
     TAG_TYPE_MAP = {
+      :enum => :int32,
+      :flags => :int32,
+      :ghash => :pointer,
+      :glist => :pointer,
+      :gslist => :pointer,
+      :strv => :pointer,
+      :c => :pointer,
+      :object => :pointer,
+      :struct => :pointer,
       :GType => gtype_type,
       :gboolean => :bool,
       :gunichar => :uint32,
@@ -30,7 +39,7 @@ module GirFFI
       case type
       when :gboolean
         :int32
-      when :utf8
+      when :utf8, :array
         :pointer
       else
         map_basic_type(type)

data/lib/gir_ffi/version.rb

@@ -1,4 +1,4 @@
 module GirFFI
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end
 

data/tasks/test.rake

@@ -1,5 +1,52 @@
 require 'rake/testtask'
 
+require 'rexml/document'
+require 'rexml/streamlistener'
+
+# Listener class used to process GIR xml data, for creating test stubs.
+class Listener
+  include REXML::StreamListener
+
+  def initialize
+    @inside_class = false
+  end
+
+  attr_accessor :result
+  attr_accessor :namespace
+
+  def tag_start name, attrs
+    return if attrs['disguised'] == '1'
+    return if attrs['introspectable'] == '0'
+    return if attrs['glib:is-gtype-struct-for']
+
+    obj_name = attrs['name']
+    case name
+    when "constant"
+      result.puts "  it \"has the constant #{obj_name}\" do"
+    when "record", "class", "enumeration", "bitfield", "interface", "union"
+      result.puts "  describe \"#{namespace}::#{obj_name}\" do"
+      @inside_class = true
+    when "constructor"
+      result.puts "    it \"creates an instance using ##{obj_name}\" do"
+    when "function", "method"
+      spaces = @inside_class ? "  " : ""
+      result.puts "  #{spaces}it \"has a working #{name} ##{obj_name}\" do"
+    when "member"
+      result.puts "    it \"has the member :#{obj_name}\" do"
+    when "type", "return-value", "parameters", "parameter", "doc", "array"
+    else
+      puts "Skipping #{name}"
+    end
+  end
+
+  def tag_end name
+    case name
+    when "record", "class", "enumeration", "bitfield", "interface", "union"
+      @inside_class = false
+    end
+  end
+end
+
 namespace :test do
   def define_test_task name
     Rake::TestTask.new(name) do |t|
@@ -54,6 +101,20 @@ namespace :test do
                    :main,
                    :overrides,
                    :integration]
+
+  task :stub => :lib do
+    file = File.new 'test/lib/Regress-1.0.gir'
+    listener = Listener.new
+    listener.result = File.open('tmp/regress_lines.rb', 'w')
+    listener.namespace = "Regress"
+    REXML::Document.parse_stream file, listener
+
+    file = File.new 'test/lib/GIMarshallingTests-1.0.gir'
+    listener = Listener.new
+    listener.result = File.open('tmp/gimarshallingtests_lines.rb', 'w')
+    listener.namespace = "GIMarshallingTests"
+    REXML::Document.parse_stream file, listener
+  end
 end
 
 file "test/lib/Makefile" => "test/lib/configure" do

data/test/base_test_helper.rb

@@ -1,6 +1,4 @@
 if RUBY_PLATFORM == 'java'
-  require 'java'
-  JRuby.objectspace = true
   require 'rubygems'
 end
 

data/test/ffi-gobject/value_test.rb

@@ -3,6 +3,21 @@ require 'gir_ffi_test_helper'
 require 'ffi-gobject'
 
 describe GObject::Value do
+  describe "::Struct" do
+    describe "layout" do
+      let(:layout) { GObject::Value::Struct.layout }
+
+      it "consists of :g_type and :data" do
+        layout.members.must_equal [:g_type, :data]
+      end
+
+      it "has an array as its second element" do
+        types = layout.fields.map(&:type)
+        types[1].class.must_equal FFI::Type::Array
+      end
+    end
+  end
+
   describe "::wrap_ruby_value" do
     it "wraps a boolean false" do
       gv = GObject::Value.wrap_ruby_value false

data/test/ffi-gobject_introspection/i_base_info_test.rb

@@ -1,15 +1,40 @@
 require 'introspection_test_helper'
 
 describe GObjectIntrospection::IBaseInfo do
-  describe "#safe_name" do
-    it "makes names starting with an underscore safe" do
-      stub(ptr = Object.new).null? { false }
+  let(:described_class) { GObjectIntrospection::IBaseInfo }
+  describe "#initialize" do
+    it "raises an error if nil is passed" do
+      proc { described_class.new nil }.must_raise ArgumentError
+    end
+
+    it "raises an error if a null pointer is passed" do
+      mock(ptr = Object.new).null? { true }
+      proc { described_class.new ptr }.must_raise ArgumentError
+    end
+
+    it "raises no error if a non-null pointer is passed" do
+      mock(ptr = Object.new).null? { false }
+      described_class.new ptr
+      pass
+    end
+  end
+
+  describe "upon garbage collection" do
+    it "calls g_base_info_unref" do
+      skip "cannot be reliably tested on JRuby" if RUBY_PLATFORM == 'java'
+      mock(ptr = Object.new).null? { false }
+      mock(lib = Object.new).g_base_info_unref(ptr) { nil }
+      described_class.new ptr, lib
 
-      info = GObjectIntrospection::IBaseInfo.wrap ptr
+      GC.start
 
-      stub(info).name { "_foo" }
+      # Yes, the next three lines are needed. https://gist.github.com/4277829
+      stub(ptr2 = Object.new).null? { false }
+      stub(lib).g_base_info_unref(ptr2) { nil }
+      described_class.new ptr2, lib
 
-      assert_equal "Private___foo", info.safe_name
+      GC.start
+      GC.start
     end
   end
 end