gir_ffi 0.2.3 → 0.3.0

data/lib/gir_ffi/arg_helper.rb

@@ -19,8 +19,8 @@ module GirFFI
       return nil if obj.nil?
       return obj if obj.is_a? FFI::Pointer
 
-      OBJECT_STORE[obj.object_id] = obj
-      FFI::Pointer.new(obj.object_id)
+      FFI::Pointer.new(obj.object_id).tap {|ptr|
+        OBJECT_STORE[ptr.address] = obj }
     end
 
     def self.ptr_to_typed_array type, ptr, size
@@ -31,8 +31,7 @@ module GirFFI
       elsif type == :utf8
         ptr_to_utf8_array ptr, size
       else
-        ffi_type = TypeMap.map_basic_type type
-        ptr.send "get_array_of_#{ffi_type}", 0, size
+        self.send "ptr_to_#{type}_array", ptr, size
       end
     end
 
@@ -41,6 +40,7 @@ module GirFFI
         ffi_type = TypeMap.map_basic_type type
         defn =
           "def self.ptr_to_#{type}_array ptr, size
+            return [] if ptr.nil? or ptr.null?
             ptr.get_array_of_#{ffi_type}(0, size)
           end"
         eval defn
@@ -50,12 +50,13 @@ module GirFFI
     setup_ptr_to_type_array_handler_for SIMPLE_G_TYPES
 
     def self.ptr_to_utf8_array ptr, size
+      return [] if ptr.nil? or ptr.null?
       ptrs = ptr.read_array_of_pointer(size)
-
       ptrs.map { |pt| ptr_to_utf8 pt }
     end
 
     def self.ptr_to_interface_array klass, ptr, size
+      return [] if ptr.nil? or ptr.null?
       struct_size = klass.ffi_structure.size
       size.times.map do |idx|
         klass.wrap(ptr + struct_size * idx)
@@ -63,6 +64,7 @@ module GirFFI
     end
 
     def self.ptr_to_interface_pointer_array klass, ptr, size
+      return [] if ptr.nil? or ptr.null?
       ptrs = ptr.read_array_of_pointer(size)
       ptrs.map do |optr|
         klass.wrap(optr)
@@ -87,7 +89,7 @@ module GirFFI
     class << self
       sz = FFI.type_size(:size_t) * 8
       type = "guint#{sz}"
-      alias_method :ptr_to_gtype_array, "ptr_to_#{type}_array"
+      alias_method :ptr_to_GType_array, "ptr_to_#{type}_array"
     end
 
     def self.check_error errpp

data/lib/gir_ffi/builder/argument.rb

@@ -546,7 +546,7 @@ module GirFFI::Builder
     def post
       size = array_size
 
-      [ "#{retname} = GirFFI::ArgHelper.ptr_to_#{subtype_tag}_array #{cvar}, #{size}" ]
+      [ "#{retname} = GirFFI::ArgHelper.ptr_to_typed_array #{subtype_tag_or_class_name}, #{cvar}, #{size}" ]
     end
   end
 

data/lib/gir_ffi/builder/field.rb

@@ -5,9 +5,10 @@ module GirFFI
   module Builder
     # Creates field getter and setter code for a given IFieldInfo.
     class Field
-      def initialize field_info, lib_module
+      def initialize field_info, lib_module, struct_class
         @info = field_info
         @libmodule = lib_module
+        @struct_class = struct_class
       end
 
       def getter_def
@@ -15,7 +16,8 @@ module GirFFI
 
         return <<-CODE
         def #{@info.name}
-          #{builder.cvar} = @struct[#{field_symbol.inspect}]
+          struct = #{@struct_class}.new @struct.to_ptr
+          #{builder.cvar} = struct[#{field_symbol.inspect}]
           #{builder.post.join("\n")}
           #{builder.retval}
         end
@@ -29,7 +31,8 @@ module GirFFI
         return <<-CODE
         def #{name}= #{builder.inarg}
           #{builder.pre.join("\n")}
-          @struct[#{name.to_sym.inspect}] = #{builder.callarg}
+          struct = #{@struct_class}.new @struct.to_ptr
+          struct[#{name.to_sym.inspect}] = #{builder.callarg}
         end
         CODE
       end

data/lib/gir_ffi/builder/property.rb

@@ -0,0 +1,28 @@
+require 'gir_ffi/info_ext/i_property_info'
+
+module GirFFI
+  module Builder
+    # Creates property getter and setter code for a given IPropertyInfo.
+    class Property
+      def initialize property_info
+        @info = property_info
+      end
+
+      def getter_def
+        return <<-CODE
+        def #{@info.getter_name}
+          get_property "#{@info.name}"
+        end
+        CODE
+      end
+
+      def setter_def
+        return <<-CODE
+        def #{@info.getter_name}= value
+          set_property "#{@info.name}", value
+        end
+        CODE
+      end
+    end
+  end
+end

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

@@ -19,11 +19,9 @@ module GirFFI
           @klass
         end
 
-        private
+        attr_reader :info
 
-        def info
-          @info
-        end
+        private
 
         def namespace_module
           @namespace_module ||= Builder.build_module @namespace
@@ -38,6 +36,10 @@ module GirFFI
             Class.new parent
           }
         end
+
+        def gir
+          @gir ||= GObjectIntrospection::IRepository.default
+        end
       end
     end
   end

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

@@ -28,6 +28,7 @@ module GirFFI
           @klass.extend InterfaceBase
           setup_constants
           stub_methods
+          setup_gtype_getter
         end
       end
     end

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

@@ -1,4 +1,7 @@
 require 'gir_ffi/builder/type/struct_based'
+require 'gir_ffi/builder/property'
+require 'gir_ffi/info_ext/i_property_info'
+
 module GirFFI
   module Builder
     module Type
@@ -30,7 +33,15 @@ module GirFFI
         private
 
         def setup_class
-          super
+          setup_layout
+          setup_constants
+          stub_methods
+          setup_gtype_getter
+          if info.fundamental?
+            setup_field_accessors
+          else
+            setup_property_accessors
+          end
           setup_vfunc_invokers
           setup_interfaces
         end
@@ -47,6 +58,20 @@ module GirFFI
           @parent
         end
 
+        def setup_property_accessors
+          info.properties.each do |prop|
+            setup_accessors_for_property_info prop
+          end
+        end
+
+        def setup_accessors_for_property_info prop
+          builder = Builder::Property.new prop
+          unless has_instance_method prop.getter_name
+            @klass.class_eval builder.getter_def
+          end
+          @klass.class_eval builder.setter_def
+        end
+
         def setup_vfunc_invokers
           info.vfuncs.each do |vfinfo|
             invoker = vfinfo.invoker

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

@@ -20,10 +20,14 @@ module GirFFI
           const_defined_for @klass, :GIR_FFI_BUILDER
         end
 
+        def target_gtype
+          info.g_type
+        end
+
         # TODO: Rename the created method, or use a constant.
         # FIXME: Only used in some of the subclases. Make mixin?
         def setup_gtype_getter
-          gtype = info.g_type
+          gtype = target_gtype
           return if gtype.nil?
           @klass.instance_eval "
             def self.get_gtype
@@ -45,6 +49,10 @@ module GirFFI
           nil
         end
 
+        def fields
+          info.fields
+        end
+
         def superclass
           unless defined? @superclass
             if parent

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

@@ -18,12 +18,19 @@ module GirFFI
         def instantiate_class
           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
           setup_interfaces
+          setup_gtype_getter
         end
 
         def setup_instance_method method
@@ -32,15 +39,30 @@ module GirFFI
 
         private
 
+        def superclass
+          GirFFI::Builder.build_by_gtype parent_gtype
+        end
+
         def parent
-          parent_type = ::GObject.type_parent @gtype
-          gir.find_by_gtype(parent_type)
+          gir.find_by_gtype parent_gtype
+        end
+
+        def parent_gtype
+          GObject.type_parent @gtype
+        end
+
+        def fields
+          []
         end
 
         def interface_infos
-          ::GObject.type_interfaces(@gtype).map do |gtype|
+          interface_gtypes.map do |gtype|
             gir.find_by_gtype gtype
-          end
+          end.compact
+        end
+
+        def interface_gtypes
+          ::GObject.type_interfaces(@gtype)
         end
 
         def interfaces
@@ -52,10 +74,6 @@ module GirFFI
         def signal_definers
           interface_infos
         end
-
-        def gir
-          @gir ||= GObjectIntrospection::IRepository.default
-        end
       end
     end
   end

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

@@ -0,0 +1,119 @@
+require 'gir_ffi/user_defined/i_object_info'
+require 'gir_ffi/user_defined/i_property_info'
+require 'gir_ffi/builder/type/object'
+
+module GirFFI
+  module Builder
+    module Type
+
+      # Implements the creation of GObject subclasses from Ruby.
+      class UserDefined < Object
+        def initialize klass, &block
+          @block = block
+          @klass_before_set_up = klass
+        end
+
+        def instantiate_class
+          @klass = @klass_before_set_up
+          @info = GirFFI::UserDefined::IObjectInfo.new
+
+          self.instance_eval(&@block) if @block
+
+          parent_type = @klass.get_gtype
+          @parent = gir.find_by_gtype(parent_type)
+
+          query_result = GObject.type_query parent_type
+          type_info = GObject::TypeInfo.new
+          type_info.class_size = query_result.class_size
+          type_info.instance_size = query_result.instance_size
+          properties.each do
+            type_info.instance_size += FFI.type_size(:int32)
+          end
+
+          new_type = GObject.type_register_static parent_type, @klass.name, type_info, 0
+
+          # TODO: Check that class ultimately derives from GObject.
+          @gtype = new_type
+          @structklass = get_or_define_class @klass, :Struct, layout_superclass
+          setup_class unless already_set_up
+        end
+
+        def setup_class
+          setup_layout
+          setup_constants
+          #stub_methods
+          setup_gtype_getter
+          setup_property_accessors
+          #setup_vfunc_invokers
+          #setup_interfaces
+          setup_constructor
+        end
+
+        private
+
+        def target_gtype
+          @gtype
+        end
+
+        def parent
+          @parent
+        end
+
+        def install_property pspec
+          pinfo = GirFFI::UserDefined::IPropertyInfo.new
+          pinfo.name = pspec.parent_instance.get_name
+          properties << pinfo
+        end
+
+        def properties
+          info.properties
+        end
+
+        def layout_specification
+          parent_spec = [:parent, superclass::Struct, 0]
+          offset = superclass::Struct.size
+          fields_spec = properties.map do |pinfo|
+            spec = [pinfo.name.to_sym, :int32, offset]
+            offset += FFI.type_size(:int32)
+            spec
+          end.flatten(1)
+          parent_spec + fields_spec
+        end
+
+        def setup_property_accessors
+          properties.each do |pinfo|
+            setup_accessors_for_param_info pinfo
+          end
+        end
+
+        def setup_accessors_for_param_info pinfo
+          code = <<-CODE
+          def #{pinfo.name}
+            @struct[:#{pinfo.name}]
+          end
+          def #{pinfo.name}= val
+            @struct[:#{pinfo.name}] = val
+          end
+          CODE
+
+          @klass.class_eval code
+        end
+
+        def method_introspection_data method
+          nil
+        end
+
+        def setup_constructor
+          code = <<-CODE
+          def self.new
+            gptr = GObject::Lib.g_object_newv #{@gtype}, 0, nil
+            self.wrap(gptr)
+          end
+          CODE
+          @klass.class_eval code
+        end
+      end
+    end
+  end
+end
+

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

@@ -26,7 +26,7 @@ module GirFFI
         end
 
         def base_layout_specification
-          info.fields.map { |finfo| finfo.layout_specification }.flatten(1)
+          fields.map { |finfo| finfo.layout_specification }.flatten(1)
         end
 
         def layout_specification
@@ -39,7 +39,7 @@ module GirFFI
         end
 
         def setup_accessors_for_field_info finfo
-          builder = Builder::Field.new(finfo, lib)
+          builder = Builder::Field.new(finfo, lib, @structklass)
           unless has_instance_method finfo.name
             @klass.class_eval builder.getter_def
           end
@@ -47,7 +47,7 @@ module GirFFI
         end
 
         def setup_field_accessors
-          info.fields.each do |finfo|
+          fields.each do |finfo|
             setup_accessors_for_field_info finfo
           end
         end

data/lib/gir_ffi/builder.rb

@@ -61,6 +61,11 @@ module GirFFI
 
     def self.ffi_function_return_type info
       rt = info.return_type
+      # FIXME: Workaround for older gobject-introspection not identifying all
+      # objects as being pointers.
+      if rt.tag == :interface and rt.interface.info_type == :object
+        return :pointer
+      end
       itypeinfo_to_ffitype rt
     end
 

data/lib/gir_ffi/class_base.rb

@@ -9,10 +9,6 @@ module GirFFI
     extend Forwardable
     def_delegators :@struct, :to_ptr
 
-    def initialize(*args)
-      @struct = ffi_structure.new(*args)
-    end
-
     def ffi_structure
       self.class.ffi_structure
     end
@@ -81,7 +77,9 @@ module GirFFI
 
       def wrap ptr
 	return nil if ptr.nil? or ptr.null?
-	_real_new ptr.to_ptr
+	obj = _real_new
+        obj.instance_variable_set :@struct, ffi_structure.new(ptr.to_ptr)
+        obj
       end
 
       # TODO: Only makes sense for :objects.
@@ -90,7 +88,9 @@ module GirFFI
       end
 
       def allocate
-	_real_new
+	obj = _real_new
+        obj.instance_variable_set :@struct, ffi_structure.new
+        obj
       end
 
       # Pass-through casting method. This may become a type checking

data/lib/gir_ffi/info_ext/i_property_info.rb

@@ -0,0 +1,12 @@
+module GirFFI
+  module InfoExt
+    module IPropertyInfo
+      def getter_name
+        name.gsub(/-/, '_')
+      end
+    end
+  end
+end
+
+GObjectIntrospection::IPropertyInfo.send :include, GirFFI::InfoExt::IPropertyInfo
+

data/lib/gir_ffi/info_ext/i_type_info.rb

@@ -14,6 +14,10 @@ module GirFFI
           :int
         when :array
           subtype = param_type(0).layout_specification_type
+          # XXX Don't use pointer directly to appease JRuby.
+          if subtype == :pointer
+            subtype = :"uint#{FFI.type_size(:pointer)*8}"
+          end
           [subtype, array_fixed_size]
         else
           ffitype

data/lib/gir_ffi/user_defined/i_base_info.rb

@@ -0,0 +1,7 @@
+module GirFFI
+  module UserDefined
+    class IBaseInfo
+      attr_accessor :name
+    end
+  end
+end

data/lib/gir_ffi/user_defined/i_object_info.rb

@@ -0,0 +1,13 @@
+require 'gir_ffi/user_defined/i_registered_type_info'
+
+module GirFFI
+  module UserDefined
+    class IObjectInfo < IRegisteredTypeInfo
+      attr_accessor :properties
+      def initialize
+        @properties = []
+      end
+    end
+  end
+end
+

data/lib/gir_ffi/user_defined/i_property_info.rb

@@ -0,0 +1,9 @@
+require 'gir_ffi/user_defined/i_base_info'
+
+module GirFFI
+  module UserDefined
+    class IPropertyInfo < IBaseInfo
+      attr_accessor :property_type
+    end
+  end
+end

data/lib/gir_ffi/user_defined/i_registered_type_info.rb

@@ -0,0 +1,10 @@
+require 'gir_ffi/user_defined/i_base_info'
+
+module GirFFI
+  module UserDefined
+    class IRegisteredTypeInfo < IBaseInfo
+    end
+  end
+end
+
+

data/lib/gir_ffi/version.rb

@@ -1,4 +1,4 @@
 module GirFFI
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end
 

data/lib/gir_ffi.rb

@@ -13,6 +13,12 @@ module GirFFI
     module_name = module_name.to_s
     GirFFI::Builder.build_module module_name, version
   end
+
+  def self.define_type klass, &block
+    Builder::Type::UserDefined.new(klass, &block).build_class
+
+    klass.get_gtype
+  end
 end
 
 require 'ffi-glib'

data/tasks/test.rake

@@ -38,13 +38,22 @@ namespace :test do
     t.ruby_opts += ["-w"]
   end
 
+  Rake::TestTask.new(:gtk) do |t|
+    t.libs = ['lib']
+    t.test_files = FileList['test/ffi-gtk/*_test.rb']
+    t.ruby_opts += ["-w"]
+  end
+
   desc 'Build Regress test library and typelib'
   task :lib => "test/lib/Makefile" do
     sh %{cd test/lib && make}
   end
 
-  task :integration => :lib
   task :run => :lib
+  task :unit => :lib
+  task :glib => :lib
+  task :gobject => :lib
+  task :integration => :lib
 
   desc 'Run rcov for the entire test suite'
   task :coverage => :lib do
@@ -63,4 +72,5 @@ end
 
 desc 'Run unit an integration tests'
 task :test => ['test:gobjectintrospection',
-  'test:unit', 'test:run', 'test:glib', 'test:gobject', 'test:integration']
+  'test:unit', 'test:run', 'test:glib', 'test:gobject', 'test:gtk',
+  'test:integration']