gir_ffi 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3de30b661f43f74216127542e5c68adc520c2fae
-  data.tar.gz: d517d1dd678fa2e4c5fb13547c6a225286afce44
+  metadata.gz: 5e373464c8f376bf817deb6d9f1d82317b9d0b6a
+  data.tar.gz: 9205d3435def6eecba27339a6bd7d0f1a114c745
 SHA512:
-  metadata.gz: 66971838b0f54a2d34b24ac782564a09cfd675236520a4212ec41af35acea4fa3ab212daab633b29b8af83d3af0a12b736656d4a50f032cd432d4dca831a4bba
-  data.tar.gz: 3a419c93f07af1e2781fb2afc2d6e4a057bbbd0802acd99d0a9ce3afea146520050615e826d38778a6e07b5edc494e792568b61f06d970caadcff4599e2d8f09
+  metadata.gz: 42daa42701febe109c324c616af3aee367be2382e6994ca7fc9b915d63ef2984daacaed84eb6e1d5dd84d125e2acc964beeacb49e465552f9b45ad57f66a676c
+  data.tar.gz: 5f88e3c9d6e23449d0b461aab4bb320322f338e40f2938f5dd2bd9408da976b941d7661ad762c2ebd218f20521adb6c34dc27deab1316724d4bb6e3de0601bc2

data/Changelog.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.8.1 / 2015-10-04
+
+* Handle struct array fields with related length fields
+* Update test library build process
+
 ## 0.8.0 / 2015-09-18
 
 * Drop official support for CRuby 1.9.3

data/README.md

@@ -93,8 +93,7 @@ If you want to send pull requests or patches, please try to follow these
 instructions. If you get stuck, make a pull request anyway and I'll try to help
 out.
 
-* Make sure `rake test` runs without reporting any failures. If your code
-  breaks existing stuff, it won't get merged in.
+* Make sure `rake test` runs without reporting any failures.
 * Add tests for your feature. Otherwise, I can't see if it works or if I
   break it later.
 * Make sure latest master merges cleanly with your branch. Things might

data/Rakefile

@@ -1,13 +1,5 @@
 require 'rake/clean'
-require 'bundler/gem_helper'
-
-class MyGemHelper < Bundler::GemHelper
-  def version_tag
-    "version-#{version}"
-  end
-end
-
-MyGemHelper.install_tasks
+require 'bundler/gem_tasks'
 
 load 'tasks/test.rake'
 

data/TODO.md

@@ -3,12 +3,15 @@
 ## Miscellaneous
 
 * MAKE CONSTRUCTOR_WRAP CHECK TYPES? This would allow GObject::Object.new to
-  work and create the correct subtype.
+  work and create the correct subtype for classes that don't define their own
+  default constructor.
 * Add tests for the other test files in gobject-introspection. Currently, only
   regress.c and gimarshallingtests.c are used, but there are 6 other files
   available.
 * Move GObjectIntrospection to GIRepository, and allow generating its own
   members.
+* Do not remove ClassBase.new. We now remove it and then add it back for the
+  default constructor, which is kind of silly.
 
 ## Memory managment
 

data/lib/gir_ffi/builders/argument_builder_collection.rb

@@ -57,14 +57,15 @@ module GirFFI
       end
 
       def set_up_argument_relations
-        @base_argument_builders.each do |arg|
-          if (idx = arg.arginfo.closure) >= 0
+        @base_argument_builders.each do |bldr|
+          if (idx = bldr.closure) >= 0
             @base_argument_builders[idx].closure = true
           end
         end
         all_builders.each do |bldr|
           if (idx = bldr.array_length_idx) >= 0
             other = @base_argument_builders[idx]
+            next unless other
 
             bldr.length_arg = other
             other.array_arg = bldr

data/lib/gir_ffi/builders/base_argument_builder.rb

@@ -60,6 +60,10 @@ module GirFFI
         type_info.array_length
       end
 
+      def closure
+        arginfo.closure
+      end
+
       def ownership_transfer
         arginfo.ownership_transfer
       end

data/lib/gir_ffi/builders/base_method_builder.rb

@@ -2,6 +2,7 @@ require 'gir_ffi/builders/argument_builder'
 require 'gir_ffi/builders/argument_builder_collection'
 require 'gir_ffi/builders/error_argument_builder'
 require 'gir_ffi/builders/method_template'
+require 'gir_ffi/builders/null_argument_builder'
 require 'gir_ffi/error_argument_info'
 require 'gir_ffi/return_value_info'
 require 'gir_ffi/variable_name_generator'
@@ -44,6 +45,8 @@ module GirFFI
         @error_argument ||=
           if @info.throws?
             ErrorArgumentBuilder.new vargen, ErrorArgumentInfo.new
+          else
+            NullArgumentBuilder.new
           end
       end
 

data/lib/gir_ffi/builders/field_builder.rb

@@ -1,5 +1,4 @@
 require 'gir_ffi/builders/argument_builder'
-require 'gir_ffi/builders/return_value_builder'
 require 'gir_ffi/variable_name_generator'
 require 'gir_ffi/field_argument_info'
 
@@ -7,11 +6,123 @@ module GirFFI
   module Builders
     # Creates field getter and setter code for a given IFieldInfo.
     class FieldBuilder
+      # Convertor for fields for field getters. Used when building getter
+      # methods.
+      class GetterArgumentBuilder < BaseArgumentBuilder
+        def initialize(var_gen, field_argument_info, field_info, options = {})
+          super(var_gen, field_argument_info)
+          @field_info = field_info
+          @length_arg = options.fetch(:length_argument) { NullArgumentBuilder.new }
+        end
+
+        def pre_conversion
+          [
+            "#{field_ptr} = @struct.to_ptr + #{field_offset}",
+            "#{typed_ptr} = GirFFI::InOutPointer.new(#{field_type_tag}, #{field_ptr})",
+            "#{bare_value} = #{typed_ptr}.to_value"
+          ]
+        end
+
+        def capture_variable_name
+          nil
+        end
+
+        def post_converted_name
+          @post_converted_name ||= if has_post_conversion?
+                                     new_variable
+                                   else
+                                     bare_value
+                                   end
+        end
+
+        def return_value_name
+          post_converted_name
+        end
+
+        def post_conversion
+          if has_post_conversion?
+            ["#{post_converted_name} = #{post_convertor.conversion}"]
+          else
+            []
+          end
+        end
+
+        private
+
+        def field_offset
+          @field_info.offset
+        end
+
+        def field_ptr
+          @field_ptr ||= @var_gen.new_var
+        end
+
+        def typed_ptr
+          @typed_ptr ||= @var_gen.new_var
+        end
+
+        def bare_value
+          @bare_value ||= @var_gen.new_var
+        end
+
+        def field_type_tag
+          @field_type_tag ||= @field_info.field_type.tag_or_class.inspect
+        end
+
+        def field_type
+          @field_type ||= @field_info.field_type
+        end
+
+        def has_post_conversion?
+          type_info.needs_c_to_ruby_conversion_for_functions?
+        end
+
+        def post_convertor
+          @post_convertor ||= CToRubyConvertor.new(type_info,
+                                                   bare_value,
+                                                   length_arg.post_converted_name)
+        end
+      end
+
+      # Class to represent argument info for the argument of a getter method.
+      # Implements the necessary parts of IArgumentInfo's interface.
+      class GetterArgumentInfo
+        attr_reader :name, :argument_type
+
+        def initialize(name, type)
+          @name = name
+          @argument_type = type
+        end
+
+        def closure
+          -1
+        end
+
+        def direction
+          :out
+        end
+
+        def ownership_transfer
+          :everything
+        end
+
+        def caller_allocates?
+          false
+        end
+
+        def skip?
+          false
+        end
+      end
+
       # Builder for field getters
       class GetterBuilder
-        def initialize(field_builder, return_value_builder)
-          @field_builder = field_builder
-          @return_value_builder = return_value_builder
+        def initialize(info)
+          @info = info
+        end
+
+        def method_definition
+          template.method_definition
         end
 
         def singleton_method?
@@ -19,7 +130,7 @@ module GirFFI
         end
 
         def method_name
-          @field_builder.field_name
+          @info.name
         end
 
         def method_arguments
@@ -27,36 +138,72 @@ module GirFFI
         end
 
         def preparation
-          [
-            "#{field_ptr} = @struct.to_ptr + #{field_offset}",
-            "#{typed_ptr} = GirFFI::InOutPointer.new(#{field_type_tag}, #{field_ptr})"
-          ]
+          []
         end
 
         def invocation
-          "#{typed_ptr}.to_value"
+          nil
         end
 
         def result
-          [@return_value_builder.return_value_name]
+          [getter_argument_builder.return_value_name]
         end
 
         private
 
-        def field_ptr
-          @field_ptr ||= @return_value_builder.new_variable
+        def var_gen
+          @var_gen ||= VariableNameGenerator.new
         end
 
-        def typed_ptr
-          @typed_ptr ||= @return_value_builder.new_variable
+        def template
+          @template ||= MethodTemplate.new(self, argument_builders)
+        end
+
+        def argument_builders
+          @argument_builders ||=
+            ArgumentBuilderCollection.new(
+              NullReturnValueBuilder.new,
+              [getter_argument_builder, length_argument_builder])
+        end
+
+        def getter_argument_builder
+          @getter_argument_builder ||=
+            GetterArgumentBuilder.new(var_gen, field_argument_info, @info,
+                                      length_argument: length_argument_builder)
+        end
+
+        def length_argument_builder
+          @length_argument_builder ||=
+            if array_length_field
+              GetterArgumentBuilder.new(var_gen, length_argument_info, array_length_field)
+            else
+              NullArgumentBuilder.new
+            end
+        end
+
+        def array_length_field
+          @info.related_array_length_field
+        end
+
+        def length_argument_info
+          @length_argument_info ||=
+            GetterArgumentInfo.new 'length', array_length_field.field_type
         end
 
         def field_offset
-          @field_builder.field_offset
+          @info.offset
         end
 
         def field_type_tag
-          @field_builder.field_type_tag
+          @field_type_tag ||= @info.field_type.tag_or_class.inspect
+        end
+
+        def field_type
+          @field_type ||= @info.field_type
+        end
+
+        def field_argument_info
+          @field_argument_info ||= GetterArgumentInfo.new 'value', field_type
         end
       end
 
@@ -84,9 +231,8 @@ module GirFFI
       end
 
       def getter_def
-        argument_builders = ArgumentBuilderCollection.new(return_value_builder, [])
-        getter_builder = GetterBuilder.new(self, return_value_builder)
-        MethodTemplate.new(getter_builder, argument_builders).method_definition
+        getter_builder = GetterBuilder.new(info)
+        getter_builder.method_definition
       end
 
       # TODO: Use MethodTemplate
@@ -106,20 +252,12 @@ module GirFFI
         CODE
       end
 
-      def field_name
-        @field_name ||= info.name
-      end
-
-      def field_offset
-        @field_offset ||= info.offset
-      end
+      private
 
       def field_type_tag
         @field_type_tag ||= info.field_type.tag_or_class.inspect
       end
 
-      private
-
       def container_class
         @container_class ||= container_module.const_get(container_info.safe_name)
       end
@@ -140,11 +278,6 @@ module GirFFI
         @field_argument_info ||= FieldArgumentInfo.new 'value', field_type
       end
 
-      def return_value_builder
-        @rv_builder ||= ReturnValueBuilder.new(VariableNameGenerator.new,
-                                               field_argument_info)
-      end
-
       def setter_builder
         @setter_builder ||= ArgumentBuilder.new(VariableNameGenerator.new,
                                                 field_argument_info)

data/lib/gir_ffi/builders/method_template.rb

@@ -74,7 +74,7 @@ module GirFFI
       end
 
       def plain_invocation
-        [@builder.invocation]
+        [@builder.invocation].compact
       end
     end
   end

data/lib/gir_ffi/builders/null_argument_builder.rb

@@ -0,0 +1,43 @@
+module GirFFI
+  # Argument builder that does nothing. Implements the Null Object pattern.
+  class NullArgumentBuilder
+    def initialize(*)
+    end
+
+    def pre_conversion
+      []
+    end
+
+    def post_conversion
+      []
+    end
+
+    def array_length_idx
+      -1
+    end
+
+    def method_argument_name
+      nil
+    end
+
+    def return_value_name
+      nil
+    end
+
+    def call_argument_name
+      nil
+    end
+
+    def capture_variable_name
+      nil
+    end
+
+    def closure
+      -1
+    end
+
+    def post_converted_name
+      nil
+    end
+  end
+end

data/lib/gir_ffi/info_ext/i_field_info.rb

@@ -5,6 +5,11 @@ module GirFFI
       def layout_specification
         [name.to_sym, field_type.to_ffi_type, offset]
       end
+
+      def related_array_length_field
+        index = field_type.array_length
+        container.fields[index] if index > -1
+      end
     end
   end
 end

data/lib/gir_ffi/version.rb

@@ -1,4 +1,4 @@
 # Current GirFFI version
 module GirFFI
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

data/tasks/test.rake

@@ -190,5 +190,5 @@ file "test/lib/Makefile" => "test/lib/configure" do
 end
 
 file "test/lib/configure" => ["test/lib/autogen.sh", "test/lib/configure.ac"] do
-  sh %{cd test/lib && NOCONFIGURE=1 ./autogen.sh}
+  sh %{cd test/lib && ./autogen.sh}
 end

data/test/gir_ffi/builders/field_builder_test.rb

@@ -104,4 +104,26 @@ describe GirFFI::Builders::FieldBuilder do
       instance.setter_def.must_equal expected
     end
   end
+
+  describe 'for a field with a related array length field' do
+    let(:field_info) { get_field_introspection_data 'GObject', 'SignalQuery', 'param_types' }
+    let(:n_params_field_info) { get_field_introspection_data 'GObject', 'SignalQuery', 'n_params' }
+
+    it 'creates the right getter method' do
+      skip if field_info.field_type.array_length < 0
+      expected = <<-CODE.reset_indentation
+        def param_types
+          _v1 = @struct.to_ptr + #{n_params_field_info.offset}
+          _v2 = GirFFI::InOutPointer.new(:guint32, _v1)
+          _v3 = _v2.to_value
+          _v4 = @struct.to_ptr + #{field_info.offset}
+          _v5 = GirFFI::InOutPointer.new([:pointer, :c], _v4)
+          _v6 = _v5.to_value
+          _v7 = GirFFI::SizedArray.wrap(:GType, _v3, _v6)
+          _v7
+        end
+      CODE
+      instance.getter_def.must_equal expected
+    end
+  end
 end

data/test/integration/generated_gobject_test.rb

@@ -55,4 +55,21 @@ describe GObject do
       instance.n_values.must_equal 0
     end
   end
+
+  describe GObject::SignalQuery do
+    it 'works' do
+      GObject::SignalQuery.new
+      pass
+    end
+
+    it 'uses the n_params field for the length of param_types' do
+      field_info = get_field_introspection_data 'GObject', 'SignalQuery', 'param_types'
+      skip if field_info.field_type.array_length < 0
+      gtype = GObject::Object.gtype
+      signals = GObject.signal_list_ids gtype
+      signal_query = GObject.signal_query signals.first
+      signal_query.n_params.must_equal 1
+      signal_query.param_types.size.must_equal 1
+    end
+  end
 end

data/test/lib/autogen.sh

@@ -1,96 +1,4 @@
 #!/bin/sh
 # Run this to generate all the initial makefiles, etc.
 
-PROJECT=GirFFITest
-
-if test ! -f configure.ac ; then
-    echo "You must run this script in the top-level $PROJECT directory"
-    exit 1
-fi
-
-DIE=0
-
-have_libtool=false
-if libtoolize --version < /dev/null > /dev/null 2>&1 ; then
-    libtool_version=`libtoolize --version |
-             head -1 |
-             sed -e 's/^\(.*\)([^)]*)\(.*\)$/\1\2/g' \
-                 -e 's/^[^0-9]*\([0-9.][0-9.]*\).*/\1/'`
-    case $libtool_version in
-        2.2*)
-        have_libtool=true
-        ;;
-        2.4*)
-        have_libtool=true
-        ;;
-    esac
-fi
-if $have_libtool ; then : ; else
-    echo
-    echo "You must have libtool >= 2.2 installed to compile $PROJECT."
-    echo "Install the appropriate package for your distribution,"
-    echo "or get the source tarball at http://ftp.gnu.org/gnu/libtool/"
-    DIE=1
-fi
-
-if autoconf --version < /dev/null > /dev/null 2>&1 ; then : ; else
-    echo
-    echo "You must have autoconf installed to compile $PROJECT."
-    echo "Install the appropriate package for your distribution,"
-    echo "or get the source tarball at http://ftp.gnu.org/gnu/autoconf/"
-    DIE=1
-fi
-
-if automake-1.14 --version < /dev/null > /dev/null 2>&1 ; then
-    AUTOMAKE=automake-1.14
-    ACLOCAL=aclocal-1.14
-else if automake-1.13 --version < /dev/null > /dev/null 2>&1 ; then
-    AUTOMAKE=automake-1.13
-    ACLOCAL=aclocal-1.13
-else if automake-1.11 --version < /dev/null > /dev/null 2>&1 ; then
-    AUTOMAKE=automake-1.11
-    ACLOCAL=aclocal-1.11
-else if automake-1.10 --version < /dev/null > /dev/null 2>&1 ; then
-    AUTOMAKE=automake-1.10
-    ACLOCAL=aclocal-1.10
-else
-    echo
-    echo "You must have automake 1.13.x, 1.11.x or 1.10.x installed to compile $PROJECT."
-    echo "Install the appropriate package for your distribution,"
-    echo "or get the source tarball at http://ftp.gnu.org/gnu/automake/"
-    DIE=1
-fi
-fi
-fi
-fi
-
-if test "$DIE" -eq 1; then
-    exit 1
-fi
-
-
-libtoolize --force || exit $?
-
-$ACLOCAL -I m4 || exit $?
-
-autoconf || exit $?
-autoheader || exit $?
-
-$AUTOMAKE --add-missing || exit $?
-
-# NOCONFIGURE is used by gnome-common; support both
-if ! test -z "$AUTOGEN_SUBDIR_MODE"; then
-    NOCONFIGURE=1
-fi
-
-if test -z "$NOCONFIGURE"; then
-    if test -z "$*"; then
-        echo "I am going to run ./configure with no arguments - if you wish "
-        echo "to pass any to it, please specify them on the $0 command line."
-    fi
-
-    ./configure --enable-maintainer-mode $AUTOGEN_CONFIGURE_ARGS "$@" || exit $?
-
-    echo
-    echo "Now type 'make' to compile $PROJECT."
-fi
+autoreconf -ivf

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gir_ffi
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Matijs van Zuijlen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2015-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -188,6 +188,7 @@ files:
 - lib/gir_ffi/builders/marshalling_method_builder.rb
 - lib/gir_ffi/builders/method_template.rb
 - lib/gir_ffi/builders/module_builder.rb
+- lib/gir_ffi/builders/null_argument_builder.rb
 - lib/gir_ffi/builders/null_convertor.rb
 - lib/gir_ffi/builders/null_return_value_builder.rb
 - lib/gir_ffi/builders/object_builder.rb