gir_ffi 0.7.10 → 0.8.0

data/lib/gir_ffi/builders/object_builder.rb

@@ -20,12 +20,12 @@ module GirFFI
         end
       end
 
-      def find_signal signal_name
+      def find_signal(signal_name)
         seek_in_ancestor_infos { |info| info.find_signal signal_name } or
           raise "Signal #{signal_name} not found"
       end
 
-      def find_property property_name
+      def find_property(property_name)
         seek_in_ancestor_infos { |info| info.find_property property_name } or
           raise "Property #{property_name} not found"
       end
@@ -99,7 +99,7 @@ module GirFFI
         end
       end
 
-      def define_vfunc_invoker vfunc_name, invoker_name
+      def define_vfunc_invoker(vfunc_name, invoker_name)
         return if vfunc_name == invoker_name
         klass.class_eval "
           def #{vfunc_name} *args, &block

data/lib/gir_ffi/builders/property_builder.rb

@@ -2,7 +2,7 @@ module GirFFI
   module Builders
     # Creates property getter and setter code for a given IPropertyInfo.
     class PropertyBuilder
-      def initialize property_info
+      def initialize(property_info)
         @info = property_info
       end
 

data/lib/gir_ffi/builders/registered_type_builder.rb

@@ -1,6 +1,8 @@
 require 'gir_ffi/builders/base_type_builder'
 require 'gir_ffi/method_stubber'
-require 'gir_ffi/class_base'
+require 'gir_ffi/builders/function_builder'
+require 'gir_ffi/builders/constructor_builder'
+require 'gir_ffi/builders/initializer_builder'
 
 module GirFFI
   module Builders
@@ -8,14 +10,16 @@ module GirFFI
     # of IRegisteredTypeInfo. These are types whose C representation is
     # complex, i.e., a struct or a union.
     class RegisteredTypeBuilder < BaseTypeBuilder
-      def setup_method method
-        go = info.find_method method
-        attach_and_define_method method, go, meta_class
+      def setup_method(method)
+        method_info = info.find_method method
+        return unless method_info
+        attach_and_define_method method_info, meta_class
       end
 
-      def setup_instance_method method
-        go = info.find_instance_method method
-        attach_and_define_method method, go, build_class
+      def setup_instance_method(method)
+        method_info = info.find_instance_method method
+        return unless method_info
+        attach_and_define_method method_info, build_class
       end
 
       def target_gtype
@@ -28,17 +32,29 @@ module GirFFI
         (class << build_class; self; end)
       end
 
-      def function_definition go
-        FunctionBuilder.new(go).generate
+      def attach_and_define_method(method_info, modul)
+        method = method_info.safe_name
+        attach_method method_info
+        remove_old_method method, modul
+        define_method method_info
+        method
+      end
+
+      def define_method(method_info)
+        if method_info.constructor?
+          build_class.class_eval InitializerBuilder.new(method_info).method_definition
+          build_class.class_eval ConstructorBuilder.new(method_info).method_definition
+        else
+          build_class.class_eval FunctionBuilder.new(method_info).method_definition
+        end
       end
 
-      def attach_and_define_method method, go, modul
-        return unless go
-        method = go.safe_name
-        Builder.attach_ffi_function lib, go
+      def remove_old_method(method, modul)
         modul.class_eval { remove_method method if method_defined? method }
-        build_class.class_eval function_definition(go)
-        method
+      end
+
+      def attach_method(method_info)
+        Builder.attach_ffi_function lib, method_info
       end
 
       def stub_methods

data/lib/gir_ffi/builders/return_value_builder.rb

@@ -1,17 +1,11 @@
 require 'gir_ffi/builders/base_argument_builder'
 require 'gir_ffi/builders/c_to_ruby_convertor'
 require 'gir_ffi/builders/closure_convertor'
-require 'gir_ffi/builders/constructor_result_convertor'
 
 module GirFFI
   module Builders
     # Implements building post-processing statements for return values.
     class ReturnValueBuilder < BaseArgumentBuilder
-      def initialize var_gen, arginfo, constructor_result = false
-        super var_gen, arginfo
-        @constructor_result = constructor_result
-      end
-
       def relevant?
         !void_return_value? && !arginfo.skip?
       end
@@ -42,20 +36,13 @@ module GirFFI
 
       private
 
-      def constructor_result?
-        @constructor_result
-      end
-
       def has_post_conversion?
-        closure? || constructor_result? ||
-          type_info.needs_c_to_ruby_conversion_for_functions?
+        closure? || type_info.needs_c_to_ruby_conversion_for_functions?
       end
 
       def post_convertor
         @post_convertor ||= if closure?
                               ClosureConvertor.new(capture_variable_name)
-                            elsif constructor_result?
-                              ConstructorResultConvertor.new(capture_variable_name)
                             else
                               CToRubyConvertor.new(type_info,
                                                    capture_variable_name,

data/lib/gir_ffi/builders/ruby_to_c_convertor.rb

@@ -3,7 +3,7 @@ module GirFFI
     # Builder that generates code to convert values from Ruby to C. Used by
     # argument builders.
     class RubyToCConvertor
-      def initialize type_info, argument_name
+      def initialize(type_info, argument_name)
         @type_info = type_info
         @argument_name = argument_name
       end
@@ -13,7 +13,7 @@ module GirFFI
         "#{@type_info.argument_class_name}.from(#{args})"
       end
 
-      def conversion_arguments name
+      def conversion_arguments(name)
         @type_info.extra_conversion_arguments.map(&:inspect).push(name).join(', ')
       end
     end

data/lib/gir_ffi/builders/signal_closure_builder.rb

@@ -11,7 +11,7 @@ module GirFFI
         klass.class_eval marshaller_definition
       end
 
-      def setup_method _method
+      def setup_method(_method)
         nil
       end
 

data/lib/gir_ffi/builders/type_builder.rb

@@ -28,12 +28,12 @@ module GirFFI
         unintrospectable: UnintrospectableBuilder
       }
 
-      def self.build info
+      def self.build(info)
         builder_for(info).build_class
       end
 
       # TODO: Pull up to include :function and :module
-      def self.builder_for info
+      def self.builder_for(info)
         TYPE_MAP[info.info_type].new(info)
       end
     end

data/lib/gir_ffi/builders/unintrospectable_builder.rb

@@ -16,7 +16,7 @@ module GirFFI
         setup_interfaces
       end
 
-      def setup_instance_method _method
+      def setup_instance_method(_method)
         false
       end
 

data/lib/gir_ffi/builders/user_defined_builder.rb

@@ -5,7 +5,7 @@ module GirFFI
   module Builders
     # Implements the creation of GObject subclasses from Ruby.
     class UserDefinedBuilder < ObjectBuilder
-      def initialize info
+      def initialize(info)
         @info = info
       end
 
@@ -62,7 +62,7 @@ module GirFFI
         end
       end
 
-      def gobject_interface_info interface
+      def gobject_interface_info(interface)
         GObject::InterfaceInfo.new.tap do |interface_info|
           interface_info.interface_init = interface_init_proc(interface)
         end
@@ -75,7 +75,7 @@ module GirFFI
         end
       end
 
-      def interface_init_proc interface
+      def interface_init_proc(interface)
         proc do |interface_ptr, _data|
           setup_interface_vfuncs interface, interface_ptr
         end
@@ -93,7 +93,7 @@ module GirFFI
         parent_gtype.class_size + interface_gtypes.map(&:class_size).inject(0, :+)
       end
 
-      def setup_properties object_class_ptr
+      def setup_properties(object_class_ptr)
         object_class = GObject::ObjectClass.wrap object_class_ptr
 
         object_class.get_property = property_getter
@@ -116,7 +116,7 @@ module GirFFI
         end
       end
 
-      def setup_vfuncs object_class_ptr
+      def setup_vfuncs(object_class_ptr)
         super_class_struct =
           superclass.gir_ffi_builder.object_class_struct::Struct.new(object_class_ptr)
 
@@ -125,7 +125,7 @@ module GirFFI
         end
       end
 
-      def setup_interface_vfuncs interface, interface_ptr
+      def setup_interface_vfuncs(interface, interface_ptr)
         interface_builder = interface.gir_ffi_builder
 
         interface_struct = interface_builder.interface_struct::Struct.new(interface_ptr)
@@ -136,7 +136,7 @@ module GirFFI
         end
       end
 
-      def setup_vfunc super_class_struct, impl
+      def setup_vfunc(super_class_struct, impl)
         vfunc_name = impl.name
         vfunc_info = parent_info.find_vfunc vfunc_name.to_s
 
@@ -145,7 +145,7 @@ module GirFFI
         end
       end
 
-      def setup_interface_vfunc interface_info, interface_struct, impl
+      def setup_interface_vfunc(interface_info, interface_struct, impl)
         vfunc_name = impl.name
         vfunc_info = interface_info.find_vfunc vfunc_name.to_s
 
@@ -154,7 +154,7 @@ module GirFFI
         end
       end
 
-      def install_vfunc container_struct, vfunc_name, vfunc_info, implementation
+      def install_vfunc(container_struct, vfunc_name, vfunc_info, implementation)
         vfunc = VFuncBuilder.new(vfunc_info).build_class
         container_struct[vfunc_name] = vfunc.from implementation
       end
@@ -180,7 +180,7 @@ module GirFFI
         end
       end
 
-      def setup_accessors_for_param_info pinfo
+      def setup_accessors_for_param_info(pinfo)
         field_name = pinfo.name
         code = <<-CODE
         def #{field_name}
@@ -194,7 +194,7 @@ module GirFFI
         klass.class_eval code
       end
 
-      def method_introspection_data _method
+      def method_introspection_data(_method)
         nil
       end
 

data/lib/gir_ffi/builders/vfunc_builder.rb

@@ -49,7 +49,7 @@ module GirFFI
 
       def argument_ffi_types
         @argument_ffi_types ||= info.argument_ffi_types.
-          unshift(receiver_type_info.to_callback_ffitype)
+          unshift(receiver_type_info.to_callback_ffi_type)
       end
 
       def return_ffi_type

data/lib/gir_ffi/callback_base.rb

@@ -12,13 +12,13 @@ module GirFFI
       FFI::Type::POINTER
     end
 
-    def self.from_native value, _context
+    def self.from_native(value, _context)
       return nil if !value || value.null?
       FFI::Function.new(gir_ffi_builder.return_ffi_type,
                         gir_ffi_builder.argument_ffi_types, value)
     end
 
-    def self.to_native value, _context
+    def self.to_native(value, _context)
       case value
       when CallbackBase
         value.to_native
@@ -27,25 +27,25 @@ module GirFFI
       end
     end
 
-    def self.wrap ptr
+    def self.wrap(ptr)
       from_native ptr, nil
     end
 
     CALLBACKS = []
 
-    def self.store_callback prc
+    def self.store_callback(prc)
       CALLBACKS << prc
     end
 
     # Create Callback from a Proc. Makes sure arguments are properly wrapped,
     # and the callback is stored to prevent garbage collection.
-    def self.from prc
+    def self.from(prc)
       wrap_in_callback_args_mapper(prc).tap do |cb|
         store_callback cb
       end
     end
 
-    def self.wrap_in_callback_args_mapper prc
+    def self.wrap_in_callback_args_mapper(prc)
       return unless prc
 
       new do |*args|
@@ -53,11 +53,6 @@ module GirFFI
       end
     end
 
-    # @deprecated Use .to_ffi_type instead. Will be removed in 0.8.0.
-    def self.to_ffitype
-      self
-    end
-
     def self.to_ffi_type
       self
     end
@@ -70,11 +65,11 @@ module GirFFI
                      end
     end
 
-    def self.copy_value_to_pointer value, pointer
+    def self.copy_value_to_pointer(value, pointer)
       pointer.put_pointer 0, to_native(value, nil)
     end
 
-    def self.get_value_from_pointer pointer
+    def self.get_value_from_pointer(pointer)
       from_native pointer.get_pointer(0), nil
     end
   end

data/lib/gir_ffi/class_base.rb

@@ -11,7 +11,7 @@ module GirFFI
     attr_reader :struct
     def_delegators :@struct, :to_ptr
 
-    def setup_and_call method, arguments, &block
+    def setup_and_call(method, arguments, &block)
       method_name = self.class.try_in_ancestors(:setup_instance_method, method.to_s)
 
       unless method_name
@@ -23,11 +23,11 @@ module GirFFI
 
     # NOTE: JRuby should fix FFI::MemoryPointer#== to return true for
     # equivalent FFI::Pointer. For now, user to_ptr.address
-    def == other
+    def ==(other)
       other.class == self.class && to_ptr.address == other.to_ptr.address
     end
 
-    def self.setup_and_call method, arguments, &block
+    def self.setup_and_call(method, arguments, &block)
       method_name = try_in_ancestors(:setup_method, method.to_s)
 
       unless method_name
@@ -37,7 +37,7 @@ module GirFFI
       send method_name, *arguments, &block
     end
 
-    def self.try_in_ancestors method, *arguments
+    def self.try_in_ancestors(method, *arguments)
       ancestors.each do |klass|
         if klass.respond_to?(method)
           result = klass.send(method, *arguments)
@@ -50,60 +50,56 @@ module GirFFI
       self::Struct
     end
 
-    class << self
-      # @deprecated Use .to_ffi_type instead. Will be removed in 0.8.0.
-      def to_ffitype
-        to_ffi_type
-      end
-
-      def setup_method name
-        gir_ffi_builder.setup_method name
-      end
+    def self.setup_method(name)
+      gir_ffi_builder.setup_method name
+    end
 
-      def setup_instance_method name
-        gir_ffi_builder.setup_instance_method name
-      end
+    def self.setup_instance_method(name)
+      gir_ffi_builder.setup_instance_method name
+    end
 
-      alias_method :_real_new, :new
+    class << self
       undef new
+    end
 
-      # Wrap the passed pointer in an instance of the current class, or a
-      # descendant type if applicable.
-      def wrap ptr
-        direct_wrap ptr
-      end
+    # Wrap the passed pointer in an instance of the current class, or a
+    # descendant type if applicable.
+    def self.wrap(ptr)
+      direct_wrap ptr
+    end
 
-      # Wrap the passed pointer in an instance of the current class. Will not
-      # do any casting to subtypes.
-      def direct_wrap ptr
-        return nil if !ptr || ptr.null?
-        obj = _real_new
-        obj.instance_variable_set :@struct, self::Struct.new(ptr)
-        obj
-      end
+    # Wrap the passed pointer in an instance of the current class. Will not
+    # do any casting to subtypes or additional processing.
+    def self.direct_wrap(ptr)
+      return nil if !ptr || ptr.null?
+      obj = allocate
+      obj.__send__ :assign_pointer, ptr
+      obj
+    end
 
-      # Pass-through casting method. This may become a type checking
-      # method. It is overridden by GValue to implement wrapping of plain
-      # Ruby objects.
-      def from val
-        val
-      end
+    # Pass-through casting method. This may become a type checking
+    # method. It is overridden by GValue to implement wrapping of plain
+    # Ruby objects.
+    def self.from(val)
+      val
     end
 
-    #
-    # Wraps a pointer retrieved from a constructor method. Here, it is simply
-    # defined as a wrapper around direct_wrap, but, e.g., InitiallyUnowned
-    # overrides it to sink the floating object.
+    private
+
+    # Stores a pointer created by a constructor function. Derived classes may
+    # perform additional processing. For example, InitiallyUnowned overrides it
+    # to sink the floating object.
     #
     # This method assumes the pointer will always be of the type corresponding
     # to the current class, and never of a subtype.
     #
     # @param ptr Pointer to the object's C structure
-    #
-    # @return An object of the current class wrapping the pointer
-    #
-    def self.constructor_wrap ptr
-      direct_wrap ptr
+    def store_pointer(ptr)
+      assign_pointer ptr
+    end
+
+    def assign_pointer(ptr)
+      @struct = self.class::Struct.new(ptr)
     end
   end
 end