gir_ffi 0.7.10 → 0.8.0

data/lib/ffi-gobject_introspection/i_repository.rb

@@ -63,15 +63,15 @@ module GObjectIntrospection
       instance
     end
 
-    def self.prepend_search_path path
+    def self.prepend_search_path(path)
       Lib.g_irepository_prepend_search_path path
     end
 
-    def self.type_tag_to_string type
+    def self.type_tag_to_string(type)
       Lib.g_type_tag_to_string type
     end
 
-    def require namespace, version = nil, flags = 0
+    def require(namespace, version = nil, flags = 0)
       errpp = FFI::MemoryPointer.new(:pointer).write_pointer nil
 
       Lib.g_irepository_require @gobj, namespace, version, flags, errpp
@@ -80,45 +80,45 @@ module GObjectIntrospection
       raise GError.new(errp).message unless errp.null?
     end
 
-    def n_infos namespace
+    def n_infos(namespace)
       Lib.g_irepository_get_n_infos @gobj, namespace
     end
 
-    def info namespace, index
+    def info(namespace, index)
       wrap_info Lib.g_irepository_get_info(@gobj, namespace, index)
     end
 
     # Utility method
-    def infos namespace
+    def infos(namespace)
       (0..(n_infos(namespace) - 1)).map do |idx|
         info namespace, idx
       end
     end
 
-    def find_by_name namespace, name
+    def find_by_name(namespace, name)
       wrap_info Lib.g_irepository_find_by_name(@gobj, namespace, name)
     end
 
-    def find_by_gtype gtype
+    def find_by_gtype(gtype)
       raise ArgumentError, "Type #{gtype} is not a valid type" if gtype == 0
       wrap_info Lib.g_irepository_find_by_gtype(@gobj, gtype)
     end
 
-    def dependencies namespace
+    def dependencies(namespace)
       strv_p = Lib.g_irepository_get_dependencies(@gobj, namespace)
       strv = GLib::Strv.new strv_p
       strv.to_a
     end
 
-    def shared_library namespace
+    def shared_library(namespace)
       Lib.g_irepository_get_shared_library @gobj, namespace
     end
 
-    def version namespace
+    def version(namespace)
       Lib.g_irepository_get_version @gobj, namespace
     end
 
-    def self.wrap_ibaseinfo_pointer ptr
+    def self.wrap_ibaseinfo_pointer(ptr)
       return nil if ptr.null?
       type = Lib.g_base_info_get_type ptr
       klass = TYPEMAP[type]
@@ -127,7 +127,7 @@ module GObjectIntrospection
 
     private
 
-    def wrap_info ptr
+    def wrap_info(ptr)
       self.class.wrap_ibaseinfo_pointer ptr
     end
   end

data/lib/ffi-gobject_introspection/i_struct_info.rb

@@ -6,7 +6,7 @@ module GObjectIntrospection
       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
 
@@ -18,7 +18,7 @@ module GObjectIntrospection
       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

@@ -10,7 +10,7 @@ module GObjectIntrospection
       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
 

data/lib/ffi-gobject_introspection/i_union_info.rb

@@ -6,7 +6,7 @@ module GObjectIntrospection
       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
 
@@ -17,14 +17,14 @@ module GObjectIntrospection
       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
 

data/lib/ffi-gobject_introspection/lib.rb

@@ -10,11 +10,11 @@ module GObjectIntrospection
     # Provide several guesses to #provide_guess, and the result in #best_guess
     # will be the best (i.e., lowest) guess.
     class VersionGuesser
-      def initialize base
+      def initialize(base)
         @guess = base
       end
 
-      def provide_guess guessed
+      def provide_guess(guessed)
         @guess = guessed if guessed < @guess
       end
 
@@ -131,14 +131,14 @@ module GObjectIntrospection
     # gobject-introspection version 0.9.0 and 0.9.1. Therefore, we need to
     # retrieve the correct values before declaring the ITypeTag enum.
     attach_function :tmp_type_tag_to_string, :g_type_tag_to_string, [:int], :string
-    type_tag_map = (0..31).map { |id|
+    type_tag_map = (0..31).map do |id|
       sym = tmp_type_tag_to_string(id).to_sym
       if sym == :unknown
         nil
       else
         [sym, id]
       end
-    }.compact.flatten
+    end.compact.flatten
     enum :ITypeTag, type_tag_map
 
     # Now, attach g_type_tag_to_string again under its own name with an

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

@@ -6,11 +6,11 @@ module GLib
     extend FFI::DataConverter
     native_type FFI::Type::INT
 
-    def self.from_native value, _context
+    def self.from_native(value, _context)
       value != 0 ? true : false
     end
 
-    def self.to_native value, _context
+    def self.to_native(value, _context)
       value ? 1 : 0
     end
 
@@ -18,11 +18,11 @@ module GLib
       FFI.type_size FFI::Type::INT
     end
 
-    def self.copy_value_to_pointer value, pointer
+    def self.copy_value_to_pointer(value, pointer)
       pointer.put_int 0, to_native(value, nil)
     end
 
-    def self.get_value_from_pointer pointer
+    def self.get_value_from_pointer(pointer)
       from_native pointer.get_int(0), nil
     end
   end

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

@@ -8,7 +8,7 @@ module GLib
 
     POINTER_SIZE = FFI.type_size(:pointer)
 
-    def initialize ptr
+    def initialize(ptr)
       @ptr = ptr
     end
 
@@ -24,7 +24,7 @@ module GLib
       end
     end
 
-    def self.wrap ptr
+    def self.wrap(ptr)
       new ptr
     end
 

data/lib/gir_ffi/allocation_helper.rb

@@ -4,7 +4,7 @@ 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
+    def self.safe_malloc(size)
       ptr = LibC.malloc size
       raise NoMemoryError if ptr.null?
       ptr

data/lib/gir_ffi/arg_helper.rb

@@ -13,11 +13,11 @@ module GirFFI
         @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.key? key
@@ -30,22 +30,22 @@ module GirFFI
 
     OBJECT_STORE = ObjectStore.new
 
-    def self.ptr_to_utf8_length ptr, len
+    def self.ptr_to_utf8_length(ptr, len)
       ptr.null? ? nil : ptr.read_string(len)
     end
 
-    def self.check_error errpp
+    def self.check_error(errpp)
       err = GLib::Error.wrap(errpp.read_pointer)
       raise GLibError, err if err
     end
 
-    def self.check_fixed_array_size size, arr, name
+    def self.check_fixed_array_size(size, arr, name)
       unless arr.size == size
         raise ArgumentError, "#{name} should have size #{size}"
       end
     end
 
-    def self.cast_from_pointer type, it
+    def self.cast_from_pointer(type, it)
       case type
       when :utf8, :filename
         it.to_utf8
@@ -72,7 +72,7 @@ module GirFFI
       end
     end
 
-    def self.cast_uint32_to_int32 val
+    def self.cast_uint32_to_int32(val)
       if val >= 0x80000000
         -(0x100000000 - val)
       else
@@ -80,7 +80,7 @@ module GirFFI
       end
     end
 
-    def self.cast_pointer_to_int32 ptr
+    def self.cast_pointer_to_int32(ptr)
       cast_uint32_to_int32(ptr.address & 0xffffffff)
     end
   end

data/lib/gir_ffi/boxed_base.rb

@@ -9,30 +9,26 @@ module GirFFI
       FFI::Type::Struct.new(self::Struct)
     end
 
-    # @deprecated Use #to_ffi_type instead. Will be removed in 0.8.0.
-    def self.to_ffitype
-      to_ffi_type
-    end
-
     def self.to_ffi_type
       self
     end
 
-    def self.to_native value, _context
+    def self.to_native(value, _context)
       value.struct
     end
 
-    def self.get_value_from_pointer pointer
+    def self.get_value_from_pointer(pointer)
       pointer.to_ptr
     end
 
-    def self.copy_value_to_pointer value, pointer, offset = 0
+    def self.copy_value_to_pointer(value, pointer, offset = 0)
       size = self::Struct.size
       pointer.put_bytes offset, value.to_ptr.read_bytes(size), 0, size
     end
 
+    # TODO: Make this behave more like a real .new method
     def self._allocate
-      obj = _real_new
+      obj = allocate
       obj.instance_variable_set :@struct, self::Struct.new
       obj
     end

data/lib/gir_ffi/builder.rb

@@ -10,23 +10,23 @@ module GirFFI
   module Builder
     extend BuilderHelper
 
-    def self.build_class info
+    def self.build_class(info)
       Builders::TypeBuilder.build(info)
     end
 
-    def self.build_by_gtype gtype
+    def self.build_by_gtype(gtype)
       info = GObjectIntrospection::IRepository.default.find_by_gtype gtype
       info ||= UnintrospectableTypeInfo.new gtype
 
       build_class info
     end
 
-    def self.build_module namespace, version = nil
+    def self.build_module(namespace, version = nil)
       Builders::ModuleBuilder.new(namespace, version).generate
     end
 
     # TODO: Move elsewhere, perhaps to FunctionBuilder.
-    def self.attach_ffi_function lib, info
+    def self.attach_ffi_function(lib, info)
       sym = info.symbol
       return if lib.method_defined? sym
 

data/lib/gir_ffi/builder_helper.rb

@@ -1,7 +1,7 @@
 module GirFFI
   # Set of helper methods used in the builders.
   module BuilderHelper
-    def optionally_define_constant parent, name
+    def optionally_define_constant(parent, name)
       if parent.const_defined? name, false
         parent.const_get name
       else
@@ -9,11 +9,11 @@ module GirFFI
       end
     end
 
-    def get_or_define_class namespace, name, parent
+    def get_or_define_class(namespace, name, parent)
       optionally_define_constant(namespace, name) { Class.new parent }
     end
 
-    def get_or_define_module parent, name
+    def get_or_define_module(parent, name)
       optionally_define_constant(parent, name) { Module.new }
     end
   end

data/lib/gir_ffi/builders/argument_builder_collection.rb

@@ -6,7 +6,7 @@ module GirFFI
     class ArgumentBuilderCollection
       attr_reader :return_value_builder
 
-      def initialize return_value_builder, argument_builders, options = {}
+      def initialize(return_value_builder, argument_builders, options = {})
         @receiver_builder = options[:receiver_builder]
         @error_argument_builder = options[:error_argument_builder]
         @base_argument_builders = argument_builders

data/lib/gir_ffi/builders/base_argument_builder.rb

@@ -22,11 +22,11 @@ module GirFFI
         @is_closure
       end
 
-      def closure= arg
+      def closure=(arg)
         @is_closure = arg
       end
 
-      def initialize var_gen, arginfo
+      def initialize(var_gen, arginfo)
         @var_gen = var_gen
         @arginfo = arginfo
         @length_arg = nil
@@ -64,7 +64,7 @@ module GirFFI
         arginfo.ownership_transfer
       end
 
-      def safe name
+      def safe(name)
         if KEYWORDS.include? name
           "#{name}_"
         else

data/lib/gir_ffi/builders/base_method_builder.rb

@@ -0,0 +1,71 @@
+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/error_argument_info'
+require 'gir_ffi/return_value_info'
+require 'gir_ffi/variable_name_generator'
+
+module GirFFI
+  module Builders
+    # Base class for method definition builders.
+    class BaseMethodBuilder
+      def vargen
+        @vargen ||= VariableNameGenerator.new
+      end
+
+      def method_definition
+        template.method_definition
+      end
+
+      def template
+        @template ||= MethodTemplate.new(self, argument_builder_collection)
+      end
+
+      # Methods used for setting up the builders
+
+      def argument_builders
+        @argument_builders ||= @info.args.map { |arg| ArgumentBuilder.new vargen, arg }
+      end
+
+      def return_value_info
+        @return_value_info ||= ReturnValueInfo.new(@info.return_type,
+                                                   @info.caller_owns,
+                                                   @info.skip_return?)
+      end
+
+      def argument_builder_collection
+        @argument_builder_collection ||= ArgumentBuilderCollection.new(
+          @return_value_builder, argument_builders,
+          error_argument_builder: error_argument)
+      end
+
+      def error_argument
+        @error_argument ||=
+          if @info.throws?
+            ErrorArgumentBuilder.new vargen, ErrorArgumentInfo.new
+          end
+      end
+
+      # Methods used by MethodTemplate
+
+      def invocation
+        "#{lib_name}.#{@info.symbol} #{function_call_arguments.join(', ')}"
+      end
+
+      def method_arguments
+        argument_builder_collection.method_argument_names
+      end
+
+      def preparation
+        []
+      end
+
+      private
+
+      def lib_name
+        "#{@info.safe_namespace}::Lib"
+      end
+    end
+  end
+end