gir_ffi 0.9.2 → 0.9.3

data/lib/gir_ffi/arg_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/allocation_helper'
 require 'gir_ffi/builder'
 require 'gir_ffi/glib_error'

data/lib/gir_ffi/boxed_base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/class_base'
 
 module GirFFI

data/lib/gir_ffi/builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/type_builder'
 require 'gir_ffi/builders/module_builder'
 require 'gir_ffi/builder_helper'

data/lib/gir_ffi/builder_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GirFFI
   # Set of helper methods used in the builders.
   module BuilderHelper

data/lib/gir_ffi/builders/argument_builder.rb

@@ -18,6 +18,10 @@ module GirFFI
         specialized_type_tag == :callback
       end
 
+      def allow_none?
+        arginfo.may_be_null?
+      end
+
       def post_converted_name
         @post_converted_name ||= if has_post_conversion?
                                    new_variable
@@ -38,24 +42,28 @@ module GirFFI
 
       def pre_conversion
         pr = []
-        case direction
-        when :in
+        if has_ingoing_component?
           pr << fixed_array_size_check if needs_size_check?
           pr << array_length_assignment if array_length_parameter?
+        end
+        case direction
+        when :in
           pr << "#{call_argument_name} = #{ingoing_convertor.conversion}"
         when :inout
-          pr << fixed_array_size_check if needs_size_check?
-          pr << array_length_assignment if array_length_parameter?
           pr << out_parameter_preparation
           pr << "#{call_argument_name}.set_value #{ingoing_convertor.conversion}"
         when :out
           pr << out_parameter_preparation
+        when :error
+          pr << "#{call_argument_name} = FFI::MemoryPointer.new(:pointer).write_pointer nil"
         end
         pr
       end
 
       def post_conversion
-        if has_post_conversion?
+        if direction == :error
+          ["GirFFI::ArgHelper.check_error(#{call_argument_name})"]
+        elsif has_post_conversion?
           value = output_value
           ["#{post_converted_name} = #{value}"]
         else
@@ -122,7 +130,11 @@ module GirFFI
       end
 
       def has_input_value?
-        (direction == :inout || direction == :in) && !skipped?
+        has_ingoing_component? && !skipped?
+      end
+
+      def has_ingoing_component?
+        (direction == :inout || direction == :in)
       end
 
       def array_length_assignment

data/lib/gir_ffi/builders/argument_builder_collection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GirFFI
   module Builders
     # Class representing the argument and return value builders for a method,
@@ -36,18 +37,10 @@ module GirFFI
       def method_argument_names
         @method_argument_names ||=
           begin
-            base = []
-            block = nil
-            argument_builders.each do |it|
-              name = it.method_argument_name
-              if !block && it.block_argument?
-                block = "&#{name}"
-              else
-                base << name
-              end
-            end
-            base << block if block
-            base.compact
+            base, block = split_off_block_argument
+            args = base_argument_names(base)
+            args << "&#{block.method_argument_name}" if block
+            args
           end
       end
 
@@ -117,6 +110,25 @@ module GirFFI
         @sorted_base_argument_builders ||= @base_argument_builders.
           sort_by.with_index { |arg, i| [arg.array_length_idx, i] }
       end
+
+      def split_off_block_argument
+        builders_with_name = argument_builders.select(&:method_argument_name)
+        blocks, base = builders_with_name.partition(&:block_argument?)
+        return base, blocks.first
+      end
+
+      def base_argument_names(arguments)
+        required_found = false
+        arguments.reverse.map do |it|
+          name = it.method_argument_name
+          if it.allow_none? && !required_found
+            "#{name} = nil"
+          else
+            required_found = true
+            name
+          end
+        end.compact.reverse
+      end
     end
   end
 end

data/lib/gir_ffi/builders/base_argument_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GirFFI
   module Builders
     # Abstract parent class of the argument building classes. These

data/lib/gir_ffi/builders/base_method_builder.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 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'
@@ -11,8 +11,17 @@ module GirFFI
   module Builders
     # Base class for method definition builders.
     class BaseMethodBuilder
-      def vargen
-        @vargen ||= VariableNameGenerator.new
+      def initialize(info, return_value_builder_class,
+                     receiver_info: nil,
+                     argument_builder_class: ArgumentBuilder)
+        @info = info
+        @return_value_builder_class = return_value_builder_class
+        @argument_builder_class = argument_builder_class
+        @receiver_info = receiver_info
+      end
+
+      def variable_generator
+        @variable_generator ||= VariableNameGenerator.new
       end
 
       def method_definition
@@ -26,7 +35,8 @@ module GirFFI
       # Methods used for setting up the builders
 
       def argument_builders
-        @argument_builders ||= @info.args.map { |arg| ArgumentBuilder.new vargen, arg }
+        @argument_builders ||=
+          @info.args.map { |arg| make_argument_builder arg }
       end
 
       def return_value_info
@@ -35,16 +45,26 @@ module GirFFI
                                                    @info.skip_return?)
       end
 
+      def return_value_builder
+        @return_value_builder = @return_value_builder_class.new(variable_generator,
+                                                                return_value_info)
+      end
+
+      def receiver_builder
+        @receiver_builder ||= @receiver_info ? make_argument_builder(@receiver_info) : nil
+      end
+
       def argument_builder_collection
-        @argument_builder_collection ||= ArgumentBuilderCollection.new(
-          @return_value_builder, argument_builders,
-          error_argument_builder: error_argument)
+        @argument_builder_collection ||=
+          ArgumentBuilderCollection.new(return_value_builder, argument_builders,
+                                        error_argument_builder: error_argument,
+                                        receiver_builder: receiver_builder)
       end
 
       def error_argument
         @error_argument ||=
-          if @info.throws?
-            ErrorArgumentBuilder.new vargen, ErrorArgumentInfo.new
+          if @info.can_throw_gerror?
+            make_argument_builder ErrorArgumentInfo.new
           else
             NullArgumentBuilder.new
           end
@@ -69,6 +89,10 @@ module GirFFI
       def lib_name
         "#{@info.safe_namespace}::Lib"
       end
+
+      def make_argument_builder(argument_info)
+        @argument_builder_class.new variable_generator, argument_info
+      end
     end
   end
 end

data/lib/gir_ffi/builders/base_type_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builder_helper'
 
 module GirFFI

data/lib/gir_ffi/builders/boxed_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/registered_type_builder'
 require 'gir_ffi/builders/with_layout'
 

data/lib/gir_ffi/builders/c_to_ruby_convertor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GirFFI
   module Builders
     # Builder that generates code to convert values from C to Ruby. Used by

data/lib/gir_ffi/builders/callback_argument_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/base_argument_builder'
 require 'gir_ffi/builders/c_to_ruby_convertor'
 require 'gir_ffi/builders/closure_convertor'
@@ -16,6 +17,10 @@ module GirFFI
         false
       end
 
+      def allow_none?
+        false
+      end
+
       def pre_converted_name
         @pre_converted_name ||= new_variable
       end

data/lib/gir_ffi/builders/callback_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/base_type_builder'
 require 'gir_ffi/builders/mapping_method_builder'
 require 'gir_ffi/callback_base'
@@ -25,11 +26,7 @@ module GirFFI
       end
 
       def mapping_method_definition
-        return_value_info = ReturnValueInfo.new(info.return_type,
-                                                info.caller_owns,
-                                                info.skip_return?)
-        MappingMethodBuilder.for_callback(info.args,
-                                          return_value_info).method_definition
+        MappingMethodBuilder.for_callback(info).method_definition
       end
 
       def callback_sym

data/lib/gir_ffi/builders/callback_return_value_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/return_value_builder'
 require 'gir_ffi/builders/ruby_to_c_convertor'
 

data/lib/gir_ffi/builders/closure_argument_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/callback_argument_builder'
 
 module GirFFI

data/lib/gir_ffi/builders/closure_convertor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GirFFI
   module Builders
     # Builder that generates code to convert closure arguments ('user data')

data/lib/gir_ffi/builders/closure_return_value_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/callback_return_value_builder'
 
 module GirFFI

data/lib/gir_ffi/builders/closure_to_pointer_convertor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GirFFI
   module Builders
     # Builder that generates code to convert closure arguments ('user data')

data/lib/gir_ffi/builders/constant_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/base_type_builder'
 module GirFFI
   module Builders

data/lib/gir_ffi/builders/constructor_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/argument_builder_collection'
 require 'gir_ffi/builders/method_template'
 require 'gir_ffi/builders/null_return_value_builder'
@@ -6,6 +7,7 @@ module GirFFI
   module Builders
     # Implements the creation of a Ruby constructor definition out of a
     # GIR IFunctionInfo.
+    # TODO: Derive from BaseMethodBuilder
     class ConstructorBuilder
       def initialize(info)
         @info = info

data/lib/gir_ffi/builders/enum_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/registered_type_builder'
 require 'gir_ffi/enum_base'
 
@@ -14,7 +15,7 @@ module GirFFI
       end
 
       def value_spec
-        info.values.map do|vinfo|
+        info.values.map do |vinfo|
           val = GirFFI::ArgHelper.cast_uint32_to_int32(vinfo.value)
           [vinfo.name.to_sym, val]
         end.flatten

data/lib/gir_ffi/builders/field_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/argument_builder'
 require 'gir_ffi/variable_name_generator'
 require 'gir_ffi/field_argument_info'
@@ -124,6 +125,7 @@ module GirFFI
       end
 
       # Builder for field getters
+      # TODO: Derive from BaseMethodBuilder
       class GetterBuilder
         def initialize(info)
           @info = info

data/lib/gir_ffi/builders/flags_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/enum_builder'
 require 'gir_ffi/flags_base'
 
@@ -14,7 +15,7 @@ module GirFFI
       end
 
       def value_spec
-        info.values.map do|vinfo|
+        info.values.map do |vinfo|
           val = GirFFI::ArgHelper.cast_uint32_to_int32(vinfo.value)
           { vinfo.name.to_sym => val }
         end.reduce(:merge)

data/lib/gir_ffi/builders/full_c_to_ruby_convertor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/c_to_ruby_convertor'
 
 module GirFFI

data/lib/gir_ffi/builders/function_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/return_value_builder'
 require 'gir_ffi/builders/base_method_builder'
 
@@ -7,9 +8,7 @@ module GirFFI
     # IFunctionInfo.
     class FunctionBuilder < BaseMethodBuilder
       def initialize(info)
-        @info = info
-        @return_value_builder = ReturnValueBuilder.new(vargen,
-                                                       return_value_info)
+        super(info, ReturnValueBuilder)
       end
 
       def method_name

data/lib/gir_ffi/builders/initializer_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/initializer_return_value_builder'
 require 'gir_ffi/builders/base_method_builder'
 
@@ -7,9 +8,7 @@ module GirFFI
     # GIR IFunctionInfo.
     class InitializerBuilder < BaseMethodBuilder
       def initialize(info)
-        @info = info
-        @return_value_builder = InitializerReturnValueBuilder.new(vargen,
-                                                                  return_value_info)
+        super(info, InitializerReturnValueBuilder)
       end
 
       def singleton_method?

data/lib/gir_ffi/builders/initializer_return_value_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/base_argument_builder'
 
 module GirFFI

data/lib/gir_ffi/builders/interface_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/registered_type_builder'
 require 'gir_ffi/interface_base'
 

data/lib/gir_ffi/builders/mapping_method_builder.rb

@@ -1,42 +1,32 @@
+# frozen_string_literal: true
 require 'gir_ffi/variable_name_generator'
 require 'gir_ffi/builders/callback_argument_builder'
 require 'gir_ffi/builders/vfunc_argument_builder'
 require 'gir_ffi/builders/callback_return_value_builder'
 require 'gir_ffi/builders/argument_builder_collection'
-require 'gir_ffi/builders/method_template'
+require 'gir_ffi/builders/base_method_builder'
 
 module GirFFI
   module Builders
     # Implements the creation mapping method for a callback or vfunc
     # handler. This method converts arguments from C to Ruby, and the
     # result from Ruby to C.
-    #
-    # TODO: Inherit from BaseMethodBuilder
-    class MappingMethodBuilder
-      def self.for_callback(argument_infos, return_value_info)
-        new nil, argument_infos, return_value_info, CallbackArgumentBuilder
+    class MappingMethodBuilder < BaseMethodBuilder
+      def self.for_callback(info)
+        new nil, info, CallbackArgumentBuilder
       end
 
-      def self.for_vfunc(receiver_info, argument_infos, return_value_info)
-        new receiver_info, argument_infos, return_value_info, VFuncArgumentBuilder
+      def self.for_vfunc(receiver_info, info)
+        new receiver_info, info, VFuncArgumentBuilder
       end
 
-      def initialize(receiver_info, argument_infos, return_value_info, builder_class)
-        @argument_builder_class = builder_class
-        receiver_builder = make_argument_builder receiver_info if receiver_info
-        argument_builders = argument_infos.map { |info| make_argument_builder info }
-        return_value_builder =
-          CallbackReturnValueBuilder.new(variable_generator, return_value_info)
-
-        @argument_builder_collection =
-          ArgumentBuilderCollection.new(return_value_builder, argument_builders,
-                                        receiver_builder: receiver_builder)
-        @template = MethodTemplate.new(self, @argument_builder_collection)
+      def initialize(receiver_info, info, builder_class)
+        super(info, CallbackReturnValueBuilder,
+              receiver_info: receiver_info,
+              argument_builder_class: builder_class)
       end
 
-      def method_definition
-        @template.method_definition
-      end
+      ## Methods used by MethodTemplate
 
       def method_name
         'call_with_argument_mapping'
@@ -44,11 +34,7 @@ module GirFFI
 
       def method_arguments
         @method_arguments ||=
-          @argument_builder_collection.method_argument_names.dup.unshift('_proc')
-      end
-
-      def preparation
-        []
+          argument_builder_collection.method_argument_names.dup.unshift('_proc')
       end
 
       def invocation
@@ -56,7 +42,7 @@ module GirFFI
       end
 
       def result
-        if (name = @argument_builder_collection.return_value_name)
+        if (name = argument_builder_collection.return_value_name)
           ["return #{name}"]
         else
           []
@@ -70,15 +56,7 @@ module GirFFI
       private
 
       def call_argument_list
-        @argument_builder_collection.call_argument_names.join(', ')
-      end
-
-      def variable_generator
-        @variable_generator ||= VariableNameGenerator.new
-      end
-
-      def make_argument_builder(argument_info)
-        @argument_builder_class.new variable_generator, argument_info
+        argument_builder_collection.call_argument_names.join(', ')
       end
     end
   end

data/lib/gir_ffi/builders/marshalling_method_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/variable_name_generator'
 require 'gir_ffi/builders/closure_argument_builder'
 require 'gir_ffi/builders/closure_return_value_builder'
@@ -9,28 +10,18 @@ module GirFFI
     # Implements the creation mapping method for a signal
     # handler. This method converts arguments from C to Ruby, and the
     # result from Ruby to C.
-    #
-    # TODO: Inherit from BaseMethodBuilder
-    class MarshallingMethodBuilder
-      def self.for_signal(receiver_info, argument_infos, return_value_info)
-        new receiver_info, argument_infos, return_value_info
+    class MarshallingMethodBuilder < BaseMethodBuilder
+      def self.for_signal(receiver_info, info)
+        new receiver_info, info
       end
 
-      def initialize(receiver_info, argument_infos, return_value_info)
-        receiver_builder = make_argument_builder receiver_info
-        argument_builders = argument_infos.map { |arg| make_argument_builder arg }
-        return_value_builder =
-          ClosureReturnValueBuilder.new(variable_generator, return_value_info)
-
-        @argument_builder_collection =
-          ArgumentBuilderCollection.new(return_value_builder, argument_builders,
-                                        receiver_builder: receiver_builder)
-        @template = MethodTemplate.new(self, @argument_builder_collection)
+      def initialize(receiver_info, info)
+        super(info, ClosureReturnValueBuilder,
+              receiver_info: receiver_info,
+              argument_builder_class: ClosureArgumentBuilder)
       end
 
-      def method_definition
-        @template.method_definition
-      end
+      ## Methods used by MethodTemplate
 
       def method_name
         'marshaller'
@@ -73,14 +64,6 @@ module GirFFI
       def param_names
         @param_names ||= @argument_builder_collection.method_argument_names
       end
-
-      def variable_generator
-        @variable_generator ||= VariableNameGenerator.new
-      end
-
-      def make_argument_builder(argument_info)
-        ClosureArgumentBuilder.new variable_generator, argument_info
-      end
     end
   end
 end

data/lib/gir_ffi/builders/method_template.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GirFFI
   module Builders
     # Encapsulates the general structure of generated methods, consisting of a
@@ -17,9 +18,9 @@ module GirFFI
 
       def method_definition
         code = "def #{qualified_method_name}"
-        code << "(#{method_arguments.join(', ')})" if method_arguments.any?
-        method_lines.each { |line| code << "\n  #{line}" }
-        code << "\nend\n"
+        code += "(#{method_arguments.join(', ')})" if method_arguments.any?
+        method_lines.each { |line| code += "\n  #{line}" }
+        code + "\nend\n"
       end
 
       private

data/lib/gir_ffi/builders/module_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builder_helper'
 require 'gir_ffi/module_base'
 require 'gir_ffi/builders/function_builder'
@@ -62,7 +63,7 @@ module GirFFI
 
       def build_dependencies
         deps = gir.dependencies @namespace
-        deps.each do|dep|
+        deps.each do |dep|
           name, version = dep.split '-'
           Builder.build_module name, version
         end

data/lib/gir_ffi/builders/null_argument_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GirFFI
   # Argument builder that does nothing. Implements the Null Object pattern.
   class NullArgumentBuilder

data/lib/gir_ffi/builders/null_class_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GirFFI
   module Builders
     # Class builder that does nothing

data/lib/gir_ffi/builders/null_convertor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GirFFI
   module Builders
     # Argument convertor that does nothing

data/lib/gir_ffi/builders/null_return_value_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GirFFI
   module Builders
     # Implements a blank return value matching ReturnValueBuilder's interface.

data/lib/gir_ffi/builders/object_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/registered_type_builder'
 require 'gir_ffi/builders/with_layout'
 require 'gir_ffi/builders/property_builder'

data/lib/gir_ffi/builders/property_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GirFFI
   module Builders
     # Creates property getter and setter code for a given IPropertyInfo.

data/lib/gir_ffi/builders/registered_type_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/base_type_builder'
 require 'gir_ffi/method_stubber'
 require 'gir_ffi/builders/function_builder'

data/lib/gir_ffi/builders/return_value_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builders/base_argument_builder'
 require 'gir_ffi/builders/full_c_to_ruby_convertor'
 require 'gir_ffi/builders/closure_convertor'

data/lib/gir_ffi/builders/ruby_to_c_convertor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GirFFI
   module Builders
     # Builder that generates code to convert values from Ruby to C. Used by