gir_ffi 0.7.4 → 0.7.5

data/lib/ffi-gobject_introspection/i_enum_info.rb

@@ -5,7 +5,8 @@ module GObjectIntrospection
     def n_values
       Lib.g_enum_info_get_n_values @gobj
     end
-    def value(index)
+
+    def value index
       IValueInfo.wrap(Lib.g_enum_info_get_value @gobj, index)
     end
     ##
@@ -14,7 +15,8 @@ module GObjectIntrospection
     def get_n_methods
       Lib.g_enum_info_get_n_methods @gobj
     end
-    def get_method(index)
+
+    def get_method index
       IFunctionInfo.wrap(Lib.g_enum_info_get_method @gobj, index)
     end
 
@@ -27,4 +29,3 @@ module GObjectIntrospection
     end
   end
 end
-

data/lib/ffi-gobject_introspection/i_function_info.rb

@@ -5,26 +5,32 @@ module GObjectIntrospection
     def symbol
       Lib.g_function_info_get_symbol @gobj
     end
+
     def flags
       Lib.g_function_info_get_flags @gobj
     end
 
-    #TODO: Use some sort of bitfield
+    # TODO: Use some sort of bitfield
     def method?
       flags & 1 != 0
     end
+
     def constructor?
       flags & 2 != 0
     end
+
     def getter?
       flags & 4 != 0
     end
+
     def setter?
       flags & 8 != 0
     end
+
     def wraps_vfunc?
       flags & 16 != 0
     end
+
     def throws?
       flags & 32 != 0
     end

data/lib/ffi-gobject_introspection/i_interface_info.rb

@@ -5,27 +5,33 @@ module GObjectIntrospection
     def n_prerequisites
       Lib.g_interface_info_get_n_prerequisites @gobj
     end
+
     def prerequisite index
       IBaseInfo.wrap(Lib.g_interface_info_get_prerequisite @gobj, index)
     end
+
     ##
     build_array_method :prerequisites
 
     def n_properties
       Lib.g_interface_info_get_n_properties @gobj
     end
+
     def property index
       IPropertyInfo.wrap(Lib.g_interface_info_get_property @gobj, index)
     end
+
     ##
     build_array_method :properties, :property
 
     def get_n_methods
       Lib.g_interface_info_get_n_methods @gobj
     end
+
     def get_method index
       IFunctionInfo.wrap(Lib.g_interface_info_get_method @gobj, index)
     end
+
     ##
     build_array_method :get_methods
 
@@ -36,9 +42,11 @@ module GObjectIntrospection
     def n_signals
       Lib.g_interface_info_get_n_signals @gobj
     end
+
     def signal index
       ISignalInfo.wrap(Lib.g_interface_info_get_signal @gobj, index)
     end
+
     ##
     build_array_method :signals
     build_finder_method :find_signal
@@ -46,9 +54,11 @@ module GObjectIntrospection
     def n_vfuncs
       Lib.g_interface_info_get_n_vfuncs @gobj
     end
+
     def vfunc index
       IVFuncInfo.wrap(Lib.g_interface_info_get_vfunc @gobj, index)
     end
+
     ##
     build_array_method :vfuncs
 
@@ -59,9 +69,11 @@ module GObjectIntrospection
     def n_constants
       Lib.g_interface_info_get_n_constants @gobj
     end
+
     def constant index
       IConstantInfo.wrap(Lib.g_interface_info_get_constant @gobj, index)
     end
+
     ##
     build_array_method :constants
 

data/lib/ffi-gobject_introspection/i_object_info.rb

@@ -25,27 +25,33 @@ module GObjectIntrospection
     def n_interfaces
       Lib.g_object_info_get_n_interfaces @gobj
     end
-    def interface(index)
+
+    def interface index
       IInterfaceInfo.wrap(Lib.g_object_info_get_interface @gobj, index)
     end
+
     ##
     build_array_method :interfaces
 
     def n_fields
       Lib.g_object_info_get_n_fields @gobj
     end
-    def field(index)
+
+    def field index
       IFieldInfo.wrap(Lib.g_object_info_get_field @gobj, index)
     end
+
     ##
     build_array_method :fields
 
     def n_properties
       Lib.g_object_info_get_n_properties @gobj
     end
-    def property(index)
+
+    def property index
       IPropertyInfo.wrap(Lib.g_object_info_get_property @gobj, index)
     end
+
     ##
     build_array_method :properties, :property
     build_finder_method :find_property, :n_properties
@@ -54,23 +60,25 @@ module GObjectIntrospection
       Lib.g_object_info_get_n_methods @gobj
     end
 
-    def get_method(index)
+    def get_method index
       IFunctionInfo.wrap(Lib.g_object_info_get_method @gobj, index)
     end
 
     ##
     build_array_method :get_methods
 
-    def find_method(name)
+    def find_method name
       IFunctionInfo.wrap(Lib.g_object_info_find_method @gobj, name)
     end
 
     def n_signals
       Lib.g_object_info_get_n_signals @gobj
     end
-    def signal(index)
+
+    def signal index
       ISignalInfo.wrap(Lib.g_object_info_get_signal @gobj, index)
     end
+
     ##
     build_array_method :signals
     build_finder_method :find_signal
@@ -78,9 +86,11 @@ module GObjectIntrospection
     def n_vfuncs
       Lib.g_object_info_get_n_vfuncs @gobj
     end
-    def vfunc(index)
+
+    def vfunc index
       IVFuncInfo.wrap(Lib.g_object_info_get_vfunc @gobj, index)
     end
+
     def find_vfunc name
       IVFuncInfo.wrap(Lib.g_object_info_find_vfunc @gobj, name)
     end
@@ -90,7 +100,8 @@ module GObjectIntrospection
     def n_constants
       Lib.g_object_info_get_n_constants @gobj
     end
-    def constant(index)
+
+    def constant index
       IConstantInfo.wrap(Lib.g_object_info_get_constant @gobj, index)
     end
     ##

data/lib/ffi-gobject_introspection/i_registered_type_info.rb

@@ -15,4 +15,3 @@ module GObjectIntrospection
     end
   end
 end
-

data/lib/ffi-gobject_introspection/i_repository.rb

@@ -22,9 +22,9 @@ require 'ffi-gobject_introspection/i_union_info'
 require 'ffi-gobject_introspection/i_enum_info'
 require 'ffi-gobject_introspection/i_flags_info'
 
-module GObjectIntrospection
-  GObject.type_init
+GObject.type_init
 
+module GObjectIntrospection
   # The Gobject Introspection Repository. This class is the point of
   # access to the introspection typelibs.
   # This class wraps the GIRepository struct.
@@ -55,13 +55,13 @@ module GObjectIntrospection
     }
 
     def initialize
-      @gobj = Lib::g_irepository_get_default
+      @gobj = Lib.g_irepository_get_default
     end
 
     include Singleton
 
     def self.default
-      self.instance
+      instance
     end
 
     def self.prepend_search_path path
@@ -86,8 +86,7 @@ module GObjectIntrospection
     end
 
     def info namespace, index
-      ptr = Lib.g_irepository_get_info @gobj, namespace, index
-      return wrap ptr
+      wrap_info Lib.g_irepository_get_info(@gobj, namespace, index)
     end
 
     # Utility method
@@ -98,14 +97,12 @@ module GObjectIntrospection
     end
 
     def find_by_name namespace, name
-      ptr = Lib.g_irepository_find_by_name @gobj, namespace, name
-      return wrap ptr
+      wrap_info Lib.g_irepository_find_by_name(@gobj, namespace, name)
     end
 
     def find_by_gtype gtype
       raise ArgumentError, "Type #{gtype} is not a valid type" if gtype == 0
-      ptr = Lib.g_irepository_find_by_gtype @gobj, gtype
-      return wrap ptr
+      wrap_info Lib.g_irepository_find_by_gtype(@gobj, gtype)
     end
 
     def dependencies namespace
@@ -120,17 +117,15 @@ module GObjectIntrospection
 
     def self.wrap_ibaseinfo_pointer ptr
       return nil if ptr.null?
-
       type = Lib.g_base_info_get_type ptr
       klass = TYPEMAP[type]
-
-      return klass.wrap(ptr)
+      klass.wrap ptr
     end
 
     private
 
-    def wrap ptr
-      IRepository.wrap_ibaseinfo_pointer ptr
+    def wrap_info ptr
+      self.class.wrap_ibaseinfo_pointer ptr
     end
   end
 end

data/lib/ffi-gobject_introspection/i_struct_info.rb

@@ -5,7 +5,8 @@ module GObjectIntrospection
     def n_fields
       Lib.g_struct_info_get_n_fields @gobj
     end
-    def field(index)
+
+    def field index
       IFieldInfo.wrap(Lib.g_struct_info_get_field @gobj, index)
     end
 
@@ -16,7 +17,8 @@ module GObjectIntrospection
     def get_n_methods
       Lib.g_struct_info_get_n_methods @gobj
     end
-    def get_method(index)
+
+    def get_method index
       IFunctionInfo.wrap(Lib.g_struct_info_get_method @gobj, index)
     end
 

data/lib/ffi-gobject_introspection/i_type_info.rb

@@ -5,12 +5,15 @@ module GObjectIntrospection
     def pointer?
       Lib.g_type_info_is_pointer @gobj
     end
+
     def tag
       Lib.g_type_info_get_tag @gobj
     end
-    def param_type(index)
+
+    def param_type index
       ITypeInfo.wrap(Lib.g_type_info_get_param_type @gobj, index)
     end
+
     def interface
       ptr = Lib.g_type_info_get_interface @gobj
       IRepository.wrap_ibaseinfo_pointer ptr
@@ -37,4 +40,3 @@ module GObjectIntrospection
     end
   end
 end
-

data/lib/ffi-gobject_introspection/i_union_info.rb

@@ -5,7 +5,8 @@ module GObjectIntrospection
     def n_fields
       Lib.g_union_info_get_n_fields @gobj
     end
-    def field(index)
+
+    def field index
       IFieldInfo.wrap(Lib.g_union_info_get_field @gobj, index)
     end
 
@@ -15,19 +16,22 @@ module GObjectIntrospection
     def get_n_methods
       Lib.g_union_info_get_n_methods @gobj
     end
-    def get_method(index)
+
+    def get_method index
       IFunctionInfo.wrap(Lib.g_union_info_get_method @gobj, index)
     end
 
     ##
     build_array_method :get_methods
 
-    def find_method(name)
+    def find_method name
       IFunctionInfo.wrap(Lib.g_union_info_find_method @gobj, name)
     end
+
     def size
       Lib.g_union_info_get_size @gobj
     end
+
     def alignment
       Lib.g_union_info_get_alignment @gobj
     end

data/lib/ffi-gobject_introspection/i_value_info.rb

@@ -7,4 +7,3 @@ module GObjectIntrospection
     end
   end
 end
-

data/lib/ffi-gobject_introspection/lib.rb

@@ -1,6 +1,7 @@
 require 'ffi'
 
 module GObjectIntrospection
+  # Module for attaching functions from the girepository library
   module Lib
     extend FFI::Library
     ffi_lib "girepository-1.0"
@@ -121,8 +122,6 @@ module GObjectIntrospection
     # improved signature.
     attach_function :g_type_tag_to_string, [:ITypeTag], :string
 
-    #define G_TYPE_TAG_IS_BASIC(tag) (tag < GI_TYPE_TAG_ARRAY)
-
     enum :IArrayType, [
       :c,
       :array,

data/lib/ffi-gobject_introspection.rb

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

data/lib/gir_ffi/allocation_helper.rb

@@ -1,6 +1,8 @@
 require 'gir_ffi/lib_c'
 
 module GirFFI
+  # Helper module providing a safe allocation method that raises an exception
+  # if memory cannot be allocated.
   module AllocationHelper
     def self.safe_malloc size
       ptr = LibC.malloc size
@@ -9,4 +11,3 @@ module GirFFI
     end
   end
 end
-

data/lib/gir_ffi/arg_helper.rb

@@ -3,17 +3,21 @@ require 'gir_ffi/builder'
 require 'gir_ffi/glib_error'
 
 module GirFFI
+  # Helper module containing methods used during argument conversion in
+  # generated methods.
   module ArgHelper
+    # Helper class for storing objects for later retrieval. Used to store user
+    # data arguments.
     class ObjectStore
       def initialize
         @store = {}
       end
 
-      def store(ptr, obj)
+      def store ptr, obj
         @store[ptr.address] = obj
       end
 
-      def fetch(ptr)
+      def fetch ptr
         return if ptr.null?
         key = ptr.address
         if @store.has_key? key

data/lib/gir_ffi/builder_helper.rb

@@ -1,4 +1,5 @@
 module GirFFI
+  # Set of helper methods used in the builders.
   module BuilderHelper
     def optionally_define_constant parent, name
       if parent.const_defined? name, false

data/lib/gir_ffi/builders/argument_builder_collection.rb

@@ -0,0 +1,67 @@
+module GirFFI
+  module Builders
+    # Class representing the argument and return value builders for a callback
+    # mapping function or marshaller. Implements collecting the conversion code
+    # and parameter and variable names for use by function builders.
+    class ArgumentBuilderCollection
+      attr_reader :return_value_builder
+      attr_reader :argument_builders
+
+      def initialize return_value_builder, argument_builders, options = {}
+        @receiver_builder = options[:receiver_builder]
+        @argument_builders = argument_builders
+        @return_value_builder = return_value_builder
+        self.class.set_up_argument_relations argument_builders
+        @argument_builders.unshift @receiver_builder if @receiver_builder
+      end
+
+      def parameter_preparation
+        argument_builders.sort_by.with_index {|arg, i|
+          [arg.type_info.array_length, i] }.map(&:pre_conversion).flatten
+      end
+
+      def return_value_conversion
+        all_builders.map(&:post_conversion).flatten
+      end
+
+      def capture_variable_names
+        @capture_variable_names ||=
+          all_builders.map(&:capture_variable_name).compact
+      end
+
+      def call_argument_names
+        @call_argument_names ||= argument_builders.map(&:call_argument_name).compact
+      end
+
+      def method_argument_names
+        @method_argument_names ||= argument_builders.map(&:method_argument_name)
+      end
+
+      def return_value_name
+        return_value_builder.return_value_name if return_value_builder.is_relevant?
+      end
+
+      def self.set_up_argument_relations argument_builders
+        argument_builders.each do |arg|
+          if (idx = arg.arginfo.closure) >= 0
+            argument_builders[idx].is_closure = true
+          end
+        end
+        argument_builders.each do |bldr|
+          if (idx = bldr.array_length_idx) >= 0
+            other = argument_builders[idx]
+
+            bldr.length_arg = other
+            other.array_arg = bldr
+          end
+        end
+      end
+
+      private
+
+      def all_builders
+        @all_builders ||= [return_value_builder] + argument_builders
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/c_to_ruby_convertor.rb

@@ -1,3 +1,5 @@
+# Builder that generates code to convert values from C to Ruby. Used by
+# argument builders.
 class GirFFI::Builders::CToRubyConvertor
   def initialize type_info, argument_name, length_arg
     @type_info = type_info

data/lib/gir_ffi/builders/callback_argument_builder.rb

@@ -5,6 +5,8 @@ require 'gir_ffi/builders/null_convertor'
 
 module GirFFI
   module Builders
+    # Convertor for arguments for ruby callbacks. Used when building the
+    # argument mapper for callbacks.
     class CallbackArgumentBuilder < BaseArgumentBuilder
       def method_argument_name
         @method_argument_name ||= name || new_variable
@@ -62,7 +64,7 @@ module GirFFI
       def pre_convertor
         @pre_convertor ||= if is_closure
                              ClosureConvertor.new(method_argument_name)
-                           elsif type_info.needs_c_to_ruby_conversion_for_callbacks?
+                           elsif needs_c_to_ruby_conversion?
                              CToRubyConvertor.new(type_info,
                                                   method_argument_name,
                                                   length_argument_name)
@@ -71,6 +73,10 @@ module GirFFI
                            end
       end
 
+      def needs_c_to_ruby_conversion?
+        type_info.needs_c_to_ruby_conversion_for_callbacks?
+      end
+
       def outgoing_post_conversion
         "#{pre_converted_name}.set_value #{outgoing_convertor.conversion}"
       end
@@ -106,10 +112,6 @@ module GirFFI
       def length_argument_name
         length_arg && length_arg.pre_converted_name
       end
-
-      def is_void_return_value?
-        specialized_type_tag == :void && !type_info.pointer?
-      end
     end
   end
 end

data/lib/gir_ffi/builders/callback_builder.rb

@@ -29,7 +29,9 @@ module GirFFI
       end
 
       def mapping_method_definition
-        MappingMethodBuilder.for_callback(info.args, info.return_type).method_definition
+        return_value_info = ReturnValueInfo.new info.return_type
+        MappingMethodBuilder.for_callback(info.args,
+                                          return_value_info).method_definition
       end
 
       def callback_sym

data/lib/gir_ffi/builders/callback_return_value_builder.rb

@@ -3,6 +3,8 @@ require 'gir_ffi/builders/ruby_to_c_convertor'
 
 module GirFFI
   module Builders
+    # Implements building post-processing statements for return values of
+    # callbacks.
     class CallbackReturnValueBuilder < BaseArgumentBuilder
       def is_relevant?
         !is_void_return_value? && !arginfo.skip?

data/lib/gir_ffi/builders/closure_argument_builder.rb

@@ -0,0 +1,13 @@
+require 'gir_ffi/builders/callback_argument_builder'
+
+module GirFFI
+  module Builders
+    # Convertor for arguments for RubyClosure objects. Used when building the
+    # marshaller for signal handler closures.
+    class ClosureArgumentBuilder < CallbackArgumentBuilder
+      def needs_c_to_ruby_conversion?
+        type_info.needs_c_to_ruby_conversion_for_closures?
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/closure_convertor.rb

@@ -1,3 +1,5 @@
+# Builder that generates code to convert closure arguments ('user data') from
+# C to Ruby. Used by argument builders.
 class GirFFI::Builders::ClosureConvertor
   def initialize argument_name
     @argument_name = argument_name

data/lib/gir_ffi/builders/closure_to_pointer_convertor.rb

@@ -1,3 +1,5 @@
+# Builder that generates code to convert closure arguments ('user data') from
+# Ruby to C. Used by argument builders.
 class GirFFI::Builders::ClosureToPointerConvertor
   def initialize argument_name
     @argument_name = argument_name

data/lib/gir_ffi/builders/constructor_result_convertor.rb

@@ -1,3 +1,4 @@
+# Builds conversion code for the result of a GObject constructor method.
 class GirFFI::Builders::ConstructorResultConvertor
   def initialize argument_name
     @argument_name = argument_name

data/lib/gir_ffi/builders/enum_builder.rb

@@ -1,5 +1,4 @@
 require 'gir_ffi/builders/registered_type_builder'
-require 'gir_ffi/builders/with_methods'
 require 'gir_ffi/enum_base'
 
 module GirFFI
@@ -8,8 +7,6 @@ module GirFFI
     # attached to the appropriate namespace module, and will be defined
     # as an enum for FFI.
     class EnumBuilder < RegisteredTypeBuilder
-      include WithMethods
-
       private
 
       def enum_sym
@@ -17,7 +14,7 @@ module GirFFI
       end
 
       def value_spec
-        return info.values.map {|vinfo|
+        info.values.map {|vinfo|
           val = GirFFI::ArgHelper.cast_uint32_to_int32(vinfo.value)
           [vinfo.name.to_sym, val]
         }.flatten

data/lib/gir_ffi/builders/field_builder.rb

@@ -40,7 +40,7 @@ module GirFFI
         field_ptr = builder.new_variable
         typed_ptr = builder.new_variable
 
-        return <<-CODE.reset_indentation
+        <<-CODE.reset_indentation
         def #{info.name}
           #{field_ptr} = @struct.to_ptr + #{info.offset}
           #{typed_ptr} = GirFFI::InOutPointer.new(#{field_type_tag_or_class.inspect}, #{field_ptr})
@@ -57,7 +57,7 @@ module GirFFI
         field_ptr = builder.new_variable
         typed_ptr = builder.new_variable
 
-        return <<-CODE.reset_indentation
+        <<-CODE.reset_indentation
         def #{info.name}= #{builder.method_argument_name}
           #{field_ptr} = @struct.to_ptr + #{info.offset}
           #{typed_ptr} = GirFFI::InOutPointer.new(#{field_type_tag_or_class.inspect}, #{field_ptr})

data/lib/gir_ffi/builders/function_builder.rb

@@ -24,7 +24,8 @@ module GirFFI
 
         set_up_argument_relations
         setup_error_argument vargen
-        return filled_out_template
+
+        filled_out_template
       end
 
       private