gir_ffi 0.5.2 → 0.6.0

data/lib/gir_ffi/builder/type/registered_type.rb

@@ -41,7 +41,7 @@ module GirFFI
           return if info.find_method 'new'
 
           (class << @klass; self; end).class_eval {
-            alias_method :new, :allocate
+            alias_method :new, :_allocate
           }
         end
 

data/lib/gir_ffi/builder/type/struct.rb

@@ -1,16 +1,31 @@
-require 'gir_ffi/builder/type/struct_based'
+require 'gir_ffi/builder/type/registered_type'
+require 'gir_ffi/builder/type/with_layout'
+require 'gir_ffi/builder/type/with_methods'
+
 module GirFFI
   module Builder
     module Type
 
       # Implements the creation of a class representing a Struct.
-      class Struct < StructBased
+      class Struct < RegisteredType
+        include WithMethods
+        include WithLayout
+
         private
 
         def setup_class
-          super
+          setup_layout
+          setup_constants
+          stub_methods
+          setup_gtype_getter
+          setup_field_accessors
           provide_constructor
         end
+
+        # FIXME: Private method only in subclass
+        def layout_superclass
+          FFI::Struct
+        end
       end
     end
   end

data/lib/gir_ffi/builder/type/unintrospectable.rb

@@ -1,4 +1,5 @@
 require 'gir_ffi/builder/type/object'
+
 module GirFFI
   module Builder
     module Type
@@ -7,23 +8,14 @@ module GirFFI
       # which no data is found in the GIR. Typically, these are created to
       # cast objects returned by a function that returns an interface.
       class Unintrospectable < Object
-        # FIXME: Breaks parent interface.
-        def initialize gtype
-          @gtype = gtype
-          @info = nil
-        end
-
         def instantiate_class
-          CACHE[@gtype] ||= Class.new(superclass)
-          @klass = CACHE[@gtype]
+          gtype = target_gtype
+          CACHE[gtype] ||= Class.new(superclass)
+          @klass = CACHE[gtype]
           @structklass = get_or_define_class @klass, :Struct, layout_superclass
           setup_class unless already_set_up
         end
 
-        def target_gtype
-          @gtype
-        end
-
         def setup_class
           setup_constants
           setup_layout
@@ -37,40 +29,8 @@ module GirFFI
 
         private
 
-        def superclass
-          GirFFI::Builder.build_by_gtype parent_gtype
-        end
-
-        def parent
-          gir.find_by_gtype parent_gtype
-        end
-
-        def parent_gtype
-          GObject.type_parent @gtype
-        end
-
-        def fields
-          []
-        end
-
-        def interface_infos
-          interface_gtypes.map do |gtype|
-            gir.find_by_gtype gtype
-          end.compact
-        end
-
-        def interface_gtypes
-          ::GObject.type_interfaces(@gtype)
-        end
-
-        def interfaces
-          interface_infos.map do |info|
-            GirFFI::Builder.build_class info
-          end
-        end
-
         def signal_definers
-          interface_infos
+          info.interfaces
         end
       end
     end

data/lib/gir_ffi/builder/type/user_defined.rb

@@ -1,5 +1,3 @@
-require 'gir_ffi/user_defined/i_object_info'
-require 'gir_ffi/user_defined/i_property_info'
 require 'gir_ffi/builder/type/object'
 
 module GirFFI
@@ -8,16 +6,12 @@ module GirFFI
 
       # Implements the creation of GObject subclasses from Ruby.
       class UserDefined < Object
-        def initialize klass, &block
-          @block = block
-          @klass_before_set_up = klass
+        def initialize info
+          @info = info
         end
 
         def instantiate_class
-          @klass = @klass_before_set_up
-          @info = GirFFI::UserDefined::IObjectInfo.new
-
-          self.instance_eval(&@block) if @block
+          @klass = @info.described_class
 
           parent_type = @klass.get_gtype
           @parent = gir.find_by_gtype(parent_type)
@@ -59,12 +53,6 @@ module GirFFI
           @parent
         end
 
-        def install_property pspec
-          pinfo = GirFFI::UserDefined::IPropertyInfo.new
-          pinfo.name = pspec.get_name
-          properties << pinfo
-        end
-
         def properties
           info.properties
         end

data/lib/gir_ffi/builder/type.rb

@@ -1,12 +1,11 @@
-require 'gir_ffi/builder_helper'
-require 'gir_ffi/builder/type/base'
 require 'gir_ffi/builder/type/callback'
 require 'gir_ffi/builder/type/constant'
 require 'gir_ffi/builder/type/enum'
-require 'gir_ffi/builder/type/union'
+require 'gir_ffi/builder/type/interface'
 require 'gir_ffi/builder/type/object'
 require 'gir_ffi/builder/type/struct'
-require 'gir_ffi/builder/type/interface'
+require 'gir_ffi/builder/type/unintrospectable'
+require 'gir_ffi/builder/type/union'
 
 module GirFFI
   # Builds a class based on information found in the introspection
@@ -23,7 +22,8 @@ module GirFFI
         :interface => Interface,
         :object => Object,
         :struct => Struct,
-        :union => Union
+        :union => Union,
+        :unintrospectable => Unintrospectable
       }
 
       def self.build info

data/lib/gir_ffi/builder.rb

@@ -1,7 +1,7 @@
 require 'gir_ffi/builder/type'
-require 'gir_ffi/builder/type/unintrospectable'
 require 'gir_ffi/builder/module'
 require 'gir_ffi/builder_helper'
+require 'gir_ffi/unintrospectable_type_info'
 
 module GirFFI
   # Builds modules and classes based on information found in the
@@ -16,96 +16,21 @@ module GirFFI
 
     def self.build_by_gtype gtype
       info = GObjectIntrospection::IRepository.default.find_by_gtype gtype
-      if info.nil?
-        Builder::Type::Unintrospectable.new(gtype).build_class
-      else
-        build_class info
-      end
+      info ||= UnintrospectableTypeInfo.new gtype
+
+      build_class info
     end
 
     def self.build_module namespace, version=nil
       Builder::Module.new(namespace, version).generate
     end
 
-    def self.build_module_non_recursive namespace, version=nil
-      Builder::Module.new(namespace, version).build_module_non_recursive
-    end
-
-    def self.build_callback callable_info, &block
-      rettype = ffi_callback_return_type callable_info
-      argtypes = ffi_callback_argument_types callable_info
-
-      FFI::Function.new rettype, argtypes, &block
-    end
-
     # TODO: Move elsewhere, perhaps to Builder::Function.
     def self.attach_ffi_function lib, info
       sym = info.symbol
       return if lib.method_defined? sym
-      argtypes = ffi_function_argument_types info
-      rt = ffi_function_return_type info
-
-      lib.attach_function sym, argtypes, rt
-    end
-
-    def self.ffi_function_argument_types info
-      types = info.args.map { |arg| iarginfo_to_ffitype arg }
-
-      if info.info_type == :function
-        types.unshift :pointer if info.method?
-        types << :pointer if info.throws?
-      end
-
-      types
-    end
-
-    def self.ffi_callback_argument_types info
-      types = info.args.map do |arg|
-        itypeinfo_to_callback_ffitype arg.argument_type
-      end
-      types.unshift(:pointer).push(:pointer)
-    end
-
-    def self.ffi_callback_return_type info
-      ffi_function_return_type info
-    end
-
-    def self.ffi_function_return_type info
-      itypeinfo_to_ffitype info.return_type
-    end
-
-    def self.itypeinfo_to_callback_ffitype info
-      tag = info.tag
-
-      return :string if tag == :utf8
-      return :pointer if info.pointer?
-
-      if tag == :interface
-        case info.interface.info_type
-        when :enum, :flags
-          :int32
-        else
-          :pointer
-        end
-      else
-        return TypeMap.map_basic_type tag
-      end
-    end
-
-    def self.itypeinfo_to_ffitype info
-      return :pointer if info.pointer?
-
-      tag = info.tag
-      if tag == :interface
-        return build_class info.interface
-      else
-        return TypeMap.map_basic_type tag
-      end
-    end
 
-    def self.iarginfo_to_ffitype info
-      return :pointer if info.direction != :in
-      return itypeinfo_to_ffitype info.argument_type
+      lib.attach_function sym, info.argument_ffi_types, info.return_ffi_type
     end
   end
 end

data/lib/gir_ffi/callback.rb

@@ -1,9 +1,72 @@
 module GirFFI
+  # Specialized kind of Proc to be used for callback arguments.
+  # TODO: Create superclass for all actual callback types that does the wrapping for this.
   class Callback < Proc
+    # Create Callback from a Proc. Makes sure arguments are properly wrapped,
+    # and the callback is stored to prevent garbage collection.
     def self.from namespace, name, prc
-      GirFFI::CallbackHelper.wrap_in_callback_args_mapper(namespace, name, prc).tap do |cb|
-        GirFFI::CallbackHelper.store_callback cb
+      wrap_in_callback_args_mapper(namespace, name, prc).tap do |cb|
+        CallbackHelper.store_callback cb
       end
     end
+
+    # TODO: Create actual callback class from the callback info, so no lookup
+    # is needed. This class can then also perform the argument mapping.
+    def self.wrap_in_callback_args_mapper namespace, name, prc
+      return prc if FFI::Function === prc
+      return nil if prc.nil?
+      info = GObjectIntrospection::IRepository.default.find_by_name namespace, name
+      return self.new do |*args|
+        prc.call(*map_callback_args(args, info))
+      end
+    end
+
+    def self.map_callback_args args, info
+      args.zip(info.args).map { |arg, inf|
+        map_single_callback_arg arg, inf.argument_type }
+    end
+
+    # TODO: Use GirFFI::ReturnValue classes for mapping.
+    def self.map_single_callback_arg arg, type
+      case type.tag
+      when :interface
+        map_interface_callback_arg arg, type
+      when :utf8
+        ArgHelper.ptr_to_utf8 arg
+      when :void
+        map_void_callback_arg arg
+      when :array
+        subtype = type.param_type(0)
+        if subtype.tag == :interface and arg.is_a?(FFI::Pointer)
+          map_interface_callback_arg arg, subtype
+        else
+          raise NotImplementedError
+        end
+      else
+        arg
+      end
+    end
+
+    def self.map_interface_callback_arg arg, type
+      iface = type.interface
+      case iface.info_type
+      when :object, :interface
+        arg.to_object
+      when :struct
+        klass = GirFFI::Builder.build_class iface
+        klass.wrap arg
+      else
+        arg
+      end
+    end
+
+    def self.map_void_callback_arg arg
+      if arg.null?
+        nil
+      else
+        GirFFI::ArgHelper::OBJECT_STORE[arg.address]
+      end
+    end
+
   end
 end

data/lib/gir_ffi/callback_helper.rb

@@ -3,62 +3,6 @@ module GirFFI
   module CallbackHelper
     CALLBACKS = []
 
-    def self.wrap_in_callback_args_mapper namespace, name, prc
-      return prc if FFI::Function === prc
-      return nil if prc.nil?
-      info = GObjectIntrospection::IRepository.default.find_by_name namespace, name
-      return Callback.new do |*args|
-        prc.call(*map_callback_args(args, info))
-      end
-    end
-
-    def self.map_callback_args args, info
-      args.zip(info.args).map { |arg, inf|
-        map_single_callback_arg arg, inf.argument_type }
-    end
-
-    # TODO: Use GirFFI::ReturnValue classes for mapping.
-    def self.map_single_callback_arg arg, type
-      case type.tag
-      when :interface
-        map_interface_callback_arg arg, type
-      when :utf8
-        ArgHelper.ptr_to_utf8 arg
-      when :void
-        map_void_callback_arg arg
-      when :array
-        subtype = type.param_type(0)
-        if subtype.tag == :interface and arg.is_a?(FFI::Pointer)
-          map_interface_callback_arg arg, subtype
-        else
-          raise NotImplementedError
-        end
-      else
-        arg
-      end
-    end
-
-    def self.map_interface_callback_arg arg, type
-      iface = type.interface
-      case iface.info_type
-      when :object, :interface
-        arg.to_object
-      when :struct
-        klass = GirFFI::Builder.build_class iface
-        klass.wrap arg
-      else
-        arg
-      end
-    end
-
-    def self.map_void_callback_arg arg
-      if arg.null?
-        nil
-      else
-        GirFFI::ArgHelper::OBJECT_STORE[arg.address]
-      end
-    end
-
     def self.store_callback prc
       CALLBACKS << prc
     end

data/lib/gir_ffi/class_base.rb

@@ -64,13 +64,13 @@ module GirFFI
       # 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.nil? or ptr.null?
+        return nil if !ptr or ptr.null?
         obj = _real_new
         obj.instance_variable_set :@struct, self::Struct.new(ptr.to_ptr)
         obj
       end
 
-      def allocate
+      def _allocate
         obj = _real_new
         obj.instance_variable_set :@struct, self::Struct.new
         obj

data/lib/gir_ffi/in_out_pointer.rb

@@ -2,12 +2,11 @@ module GirFFI
   # The InOutPointer class handles conversion between ruby types and
   # pointers for arguments with direction :inout and :out.
   class InOutPointer < FFI::Pointer
-    attr_reader :value_type, :sub_type
+    attr_reader :value_type
 
-    def initialize value, type, sub_type=nil
+    def initialize value, type
       @ffi_type = TypeMap.map_basic_type_or_string type
       @value_type = type
-      @sub_type = sub_type
 
       value = adjust_value_in value
 
@@ -24,34 +23,15 @@ module GirFFI
       adjust_value_out value
     end
 
-    def to_sized_array_value size
-      # FIXME: Simulated Polymorphism.
-      raise "Not allowed" if @ffi_type != :pointer or @sub_type.nil?
-      block = self.read_pointer
-      return nil if block.null?
-      ArgHelper.ptr_to_typed_array @sub_type, block, size
-    end
-
-    def self.for type, sub_type=nil
+    def self.for type
       if Array === type
         return self.new nil, *type
       end
-      self.new nil, type, sub_type
+      self.new nil, type
     end
 
-    def self.from type, value, sub_type=nil
-      if Array === type
-        _, sub_t = *type
-        # TODO: Take array type into account (zero-terminated or not)
-        return self.from_array sub_t, value
-      end
-      self.new value, type, sub_type
-    end
-
-    def self.from_array type, array
-      return nil if array.nil?
-      ptr = InPointer.from_array(type, array)
-      self.from :pointer, ptr, type
+    def self.from type, value
+      self.new value, type
     end
 
     private
@@ -60,6 +40,7 @@ module GirFFI
       case @value_type
       when :gboolean
         (value ? 1 : 0)
+      # TODO: Remove all references to :utf8 from this class
       when :utf8
         InPointer.from :utf8, value
       else
@@ -75,8 +56,6 @@ module GirFFI
       case @value_type
       when :gboolean
         (value != 0)
-      when :utf8
-        ArgHelper.ptr_to_utf8 value
       else
         value
       end

data/lib/gir_ffi/in_pointer.rb

@@ -4,30 +4,22 @@ module GirFFI
   # arrays, strings, or interfaces.
   class InPointer < FFI::Pointer
     def self.from_array type, ary
-      return nil if ary.nil?
+      return if !ary
       case type
       when :utf8, :filename
         from_utf8_array ary
-      when :interface_pointer
-        from_interface_pointer_array ary
       when Symbol
         from_basic_type_array type, ary
       when FFI::Enum
         from_enum_array type, ary
-      when Array
-        from_interface_pointer_array ary
       else
         raise NotImplementedError, type
       end
     end
 
     def self.from type, val
-      return nil if val.nil?
+      return if !val
       case type
-      when Array
-        _, sub_t = *type
-        # TODO: Take array type into account (zero-terminated or not)
-        self.from_array sub_t, val
       when :utf8, :filename
         from_utf8 val
       when :gint32, :gint8
@@ -44,38 +36,39 @@ module GirFFI
       private
 
       def from_utf8_array ary
-        ptr_ary = ary.map {|str| self.from :utf8, str}
+        ptr_ary = ary.map {|str| from_utf8 str}
         ptr_ary << nil
-        self.from_array :pointer, ptr_ary
+        from_basic_type_array :pointer, ptr_ary
       end
 
       def from_interface_pointer_array ary
         ptr_ary = ary.map {|ifc| ifc.to_ptr}
         ptr_ary << nil
-        self.from_array :pointer, ptr_ary
+        from_basic_type_array :pointer, ptr_ary
       end
 
       def from_enum_array type, ary
-        self.from_array :int32, ary.map {|sym| type.to_native sym, nil }
+        from_basic_type_array :int32, ary.map {|sym| type.to_native sym, nil }
       end
 
       def from_utf8 str
         len = str.bytesize
         ptr = AllocationHelper.safe_malloc(len + 1).write_string(str).put_char(len, 0)
-        self.new ptr
+        new ptr
       end
 
       def from_basic_type_array type, ary
         ffi_type = TypeMap.map_basic_type type
-        block = ArgHelper.allocate_array_of_type ffi_type, ary.length + 1
+        length = ary.length
+
+        block = ArgHelper.allocate_array_of_type ffi_type, length + 1
         block.send "put_array_of_#{ffi_type}", 0, ary
         block.send("put_#{ffi_type}",
-                   ary.length * FFI.type_size(ffi_type),
+                   length * FFI.type_size(ffi_type),
                    (ffi_type == :pointer ? nil : 0))
 
-        self.new block
+        new block
       end
-
     end
   end
 end

data/lib/gir_ffi/info_ext/i_arg_info.rb

@@ -19,6 +19,11 @@ module GirFFI
           arg
         end
       end
+
+      def to_ffitype
+        return :pointer if direction != :in
+        return argument_type.to_ffitype
+      end
     end
   end
 end

data/lib/gir_ffi/info_ext/i_callable_info.rb

@@ -0,0 +1,16 @@
+module GirFFI
+  module InfoExt
+    # Extensions for GObjectIntrospection::ICallableInfo needed by GirFFI
+    module ICallableInfo
+      def argument_ffi_types
+        args.map { |arg| arg.to_ffitype }
+      end
+
+      def return_ffi_type
+        return_type.to_ffitype
+      end
+    end
+  end
+end
+
+GObjectIntrospection::ICallableInfo.send :include, GirFFI::InfoExt::ICallableInfo

data/lib/gir_ffi/info_ext/i_function_info.rb

@@ -0,0 +1,15 @@
+module GirFFI
+  module InfoExt
+    # Extensions for GObjectIntrospection::IFunctionInfo needed by GirFFI
+    module IFunctionInfo
+      def argument_ffi_types
+        super.tap do |types|
+          types.unshift :pointer if method?
+          types << :pointer if throws?
+        end
+      end
+    end
+  end
+end
+
+GObjectIntrospection::IFunctionInfo.send :include, GirFFI::InfoExt::IFunctionInfo