gir_ffi 0.0.7 → 0.0.8

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

@@ -0,0 +1,27 @@
+require 'gir_ffi/builder/type/base'
+module GirFFI
+  module Builder
+    module Type
+
+      # Implements the creation of an enum or flags type. The type will be
+      # attached to the appropriate namespace module, and will be defined
+      # as an enum for FFI.
+      class Enum < Base
+        def build_class
+          unless defined? @klass
+            instantiate_enum_class
+          end
+          @klass
+        end
+
+        def instantiate_enum_class
+          @klass = optionally_define_constant namespace_module, @classname do
+            vals = info.values.map {|vinfo| [vinfo.name.to_sym, vinfo.value]}.flatten
+            lib.enum(@classname.to_sym, vals)
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,12 @@
+require 'gir_ffi/builder/type/struct_based'
+module GirFFI
+  module Builder
+    module Type
+
+      # Implements the creation of a class representing an Interface.
+      class Interface < StructBased
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,46 @@
+require 'gir_ffi/builder/type/struct_based'
+module GirFFI
+  module Builder
+    module Type
+
+      # Implements the creation of a class representing a GObject Object.
+      class Object < StructBased
+        def setup_class
+          super
+          setup_vfunc_invokers
+        end
+
+        def parent
+          unless defined? @parent
+            pr = info.parent
+            if pr.nil? or (pr.name == @classname and pr.namespace == @namespace)
+              @parent = nil
+            else
+              @parent = pr
+            end
+          end
+          @parent
+        end
+
+        def setup_vfunc_invokers
+          info.vfuncs.each do |vfinfo|
+            invoker = vfinfo.invoker
+            next if invoker.nil?
+            next if invoker.name == vfinfo.name
+
+            @klass.class_eval "
+              def #{vfinfo.name} *args, &block
+                #{invoker.name}(*args, &block)
+              end
+            "
+          end
+        end
+
+        def signal_definers
+          [info] + info.interfaces
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,156 @@
+require 'gir_ffi/builder/type/base'
+module GirFFI
+  module Builder
+    module Type
+
+      # Base class for type builders building types specified by subtypes
+      # of IRegisteredTypeInfo. These are types whose C representation is
+      # complex, i.e., a struct or a union.
+      class RegisteredType < Base
+        def setup_method method
+          klass = build_class
+          meta = (class << klass; self; end)
+
+          go = method_introspection_data method
+          raise NoMethodError unless go
+          attach_and_define_method method, go, meta
+        end
+
+        def setup_instance_method method
+          go = instance_method_introspection_data method
+          result = attach_and_define_method method, go, build_class
+
+          unless result
+            if parent
+              return superclass.gir_ffi_builder.setup_instance_method method
+            else
+              return false
+            end
+          end
+
+          true
+        end
+
+        private
+
+        def method_introspection_data method
+          info.find_method method
+        end
+
+        def instance_method_introspection_data method
+          data = method_introspection_data method
+          return !data.nil? && data.method? ? data : nil
+        end
+
+        def function_definition go
+          Builder::Function.new(go, lib).generate
+        end
+
+        def attach_and_define_method method, go, modul
+          return false if go.nil?
+          Builder.attach_ffi_function lib, go
+          modul.class_eval { remove_method method }
+          modul.class_eval function_definition(go)
+          true
+        end
+
+        def setup_class
+          setup_layout
+          setup_constants
+          stub_methods
+          setup_gtype_getter
+        end
+
+        def setup_layout
+          spec = layout_specification
+          @structklass.class_eval { layout(*spec) }
+        end
+
+        def layout_specification
+          fields = if info.info_type == :interface
+                     []
+                   else
+                     info.fields
+                   end
+
+          if fields.empty?
+            if parent
+              return [:parent, superclass.const_get(:Struct), 0]
+            else
+              return [:dummy, :char, 0]
+            end
+          end
+
+          fields.map do |finfo|
+            [ finfo.name.to_sym,
+              itypeinfo_to_ffitype_for_struct(finfo.field_type),
+              finfo.offset ]
+          end.flatten
+        end
+
+        def itypeinfo_to_ffitype_for_struct typeinfo
+          ffitype = Builder.itypeinfo_to_ffitype typeinfo
+          if ffitype.kind_of?(Class) and const_defined_for ffitype, :Struct
+            ffitype = ffitype.const_get :Struct
+          end
+          if ffitype == :bool
+            ffitype = :int
+          end
+          ffitype
+        end
+
+        def setup_constants
+          @klass.const_set :GIR_INFO, info
+          @klass.const_set :GIR_FFI_BUILDER, self
+        end
+
+        def already_set_up
+          const_defined_for @klass, :GIR_FFI_BUILDER
+        end
+
+        def stub_methods
+          info.get_methods.each do |minfo|
+            @klass.class_eval method_stub(minfo.name, minfo.method?)
+          end
+        end
+
+        def method_stub symbol, is_instance_method
+          "
+            def #{is_instance_method ? '' : 'self.'}#{symbol} *args, &block
+              setup_and_call :#{symbol}, *args, &block
+            end
+          "
+        end
+
+        def setup_gtype_getter
+          getter = info.type_init
+          return if getter.nil? or getter == "intern"
+          lib.attach_function getter.to_sym, [], :size_t
+          @klass.class_eval "
+            def self.get_gtype
+              ::#{lib}.#{getter}
+            end
+          "
+        end
+
+        def parent
+          nil
+        end
+
+        def superclass
+          unless defined? @superclass
+            if parent
+              @superclass = Builder.build_class parent
+            else
+              @superclass = GirFFI::ClassBase
+            end
+          end
+          @superclass
+        end
+      end
+    end
+  end
+end
+
+
+

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

@@ -0,0 +1,25 @@
+require 'gir_ffi/builder/type/struct_based'
+module GirFFI
+  module Builder
+    module Type
+
+      # Implements the creation of a class representing a Struct.
+      class Struct < StructBased
+        def setup_class
+          super
+          provide_struct_constructor
+        end
+
+        def provide_struct_constructor
+          return if info.find_method 'new'
+
+          (class << @klass; self; end).class_eval {
+            alias_method :new, :allocate
+          }
+        end
+      end
+    end
+  end
+end
+
+

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

@@ -0,0 +1,40 @@
+require 'gir_ffi/builder/type/registered_type'
+module GirFFI
+  module Builder
+    module Type
+
+      # Implements the creation of a class representing one of the types
+      # whose C representation is a struct, i.e., :object, :struct, and
+      # :interface.
+      class StructBased < RegisteredType
+        def build_class
+          unless defined? @klass
+            instantiate_struct_class
+          end
+          @klass
+        end
+
+        def instantiate_struct_class
+          @klass = get_or_define_class namespace_module, @classname, superclass
+          @structklass = get_or_define_class @klass, :Struct, FFI::Struct
+          setup_class unless already_set_up
+        end
+
+        def find_signal signal_name
+          signal_definers.each do |inf|
+            inf.signals.each do |sig|
+              return sig if sig.name == signal_name
+            end
+          end
+          if parent
+            return superclass.gir_ffi_builder.find_signal signal_name
+          end
+        end
+
+        def signal_definers
+          [info]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'gir_ffi/builder/type/registered_type'
+module GirFFI
+  module Builder
+    module Type
+
+      # Implements the creation of a class representing union type. The
+      # class will have a nested FFI::Union class to represent its C union.
+      class Union < RegisteredType
+        def build_class
+          unless defined? @klass
+            instantiate_union_class
+          end
+          @klass
+        end
+
+        def instantiate_union_class
+          @klass = get_or_define_class namespace_module, @classname, superclass
+          @structklass = get_or_define_class @klass, :Struct, FFI::Union
+          setup_class unless already_set_up
+        end
+      end
+    end
+  end
+end
+
+

data/lib/gir_ffi/builder/type.rb

@@ -0,0 +1,33 @@
+require 'gir_ffi/builder_helper'
+require 'gir_ffi/builder/type/base'
+require 'gir_ffi/builder/type/callback'
+require 'gir_ffi/builder/type/enum'
+require 'gir_ffi/builder/type/union'
+require 'gir_ffi/builder/type/object'
+require 'gir_ffi/builder/type/struct'
+require 'gir_ffi/builder/type/interface'
+
+module GirFFI
+  # Builds a class based on information found in the introspection
+  # repository.
+  module Builder
+    module Type
+      def self.build info
+        case info.info_type
+        when :callback
+          Callback
+        when :enum, :flags
+          Enum
+        when :union
+          Union
+        when :object
+          Object
+        when :struct
+          Struct
+        when :interface
+          Interface
+        end.new(info).build_class
+      end
+    end
+  end
+end

data/lib/gir_ffi/builder.rb

@@ -1,7 +1,7 @@
 require 'gir_ffi/arg_helper'
 require 'gir_ffi/builder/function'
 require 'gir_ffi/class_base'
-require 'gir_ffi/builder/class'
+require 'gir_ffi/builder/type'
 require 'gir_ffi/builder/module'
 require 'gir_ffi/builder_helper'
 
@@ -10,14 +10,10 @@ module GirFFI
   # introspection repository. Call its build_module and build_class methods
   # to create the modules and classes used in your program.
   module Builder
-    FFI_TYPE_FOR_SSIZE_T = "int#{FFI.type_size(:size_t) * 8}".to_sym
-
     extend BuilderHelper
 
     TAG_TYPE_MAP = {
-      :boolean => :bool,
       :GType => :size_t,
-      :size => :size_t,
       :gboolean => :bool,
       :gint8 => :int8,
       :guint8 => :uint8,
@@ -29,14 +25,15 @@ module GirFFI
       :guint64 => :uint64,
       :gfloat => :float,
       :gdouble => :double,
+      :void => :void
     }
 
     def self.build_class info
-      Builder::Class.new(info).generate
+      Builder::Type.build(info)
     end
 
-    def self.build_module namespace
-      Builder::Module.new(namespace).generate
+    def self.build_module namespace, version=nil
+      Builder::Module.new(namespace, version).generate
     end
 
     def self.attach_ffi_function lib, info
@@ -48,61 +45,36 @@ module GirFFI
     end
 
     def self.ffi_function_argument_types info
-      types = info.args.map do |arg|
-	tp = iarginfo_to_ffitype arg
-	tp == :string ? :pointer : tp
-      end
-      if info.type == :function
+      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_function_return_type info
-      itypeinfo_to_ffitype info.return_type
+      rt = info.return_type
+      return :string if rt.tag == :utf8
+      itypeinfo_to_ffitype rt
     end
 
     def self.itypeinfo_to_ffitype info
-      tag = info.tag
-
-      if info.pointer?
-	return :string if tag == :utf8
-	return :pointer
-      end
+      return :pointer if info.pointer?
 
-      case tag
-      when :interface
-	interface = info.interface
-        return build_class interface
-      when :ssize
-        return FFI_TYPE_FOR_SSIZE_T
+      tag = info.tag
+      if tag == :interface
+        return build_class info.interface
       else
-        if TAG_TYPE_MAP[tag]
-	  return TAG_TYPE_MAP[tag]
-	else
-	  return tag
-	end
+        return TAG_TYPE_MAP[tag]
       end
     end
 
     def self.iarginfo_to_ffitype info
-      return :pointer if info.direction == :inout
-      return :pointer if info.direction == :out
-      return itypeinfo_to_ffitype info.type
-    end
-
-    def self.build_callback interface
-      modul = build_module interface.namespace
-      lib = modul.const_get(:Lib)
-
-      sym = interface.name.to_sym
-
-      optionally_define_constant modul, sym do
-	args = ffi_function_argument_types interface
-	ret = ffi_function_return_type interface
-	lib.callback sym, args, ret
-      end
+      return :pointer if info.direction != :in
+      return itypeinfo_to_ffitype info.argument_type
     end
   end
 end

data/lib/gir_ffi/i_arg_info.rb

@@ -6,32 +6,42 @@ module GirFFI
     def direction
       Lib.g_arg_info_get_direction @gobj
     end
+
     def return_value?
       Lib.g_arg_info_is_return_value @gobj
     end
+
     def optional?
       Lib.g_arg_info_is_optional @gobj
     end
+
     def caller_allocates?
       Lib.g_arg_info_is_caller_allocates @gobj
     end
+
     def may_be_null?
       Lib.g_arg_info_may_be_null @gobj
     end
+
     def ownership_transfer
       Lib.g_arg_info_get_ownership_transfer @gobj
     end
+
     def scope
       Lib.g_arg_info_get_scope @gobj
     end
+
     def closure
       Lib.g_arg_info_get_closure @gobj
     end
+
     def destroy
       Lib.g_arg_info_get_destroy @gobj
     end
-    def type
+
+    def argument_type
       ITypeInfo.wrap(Lib.g_arg_info_get_type @gobj)
     end
   end
 end
+

data/lib/gir_ffi/i_base_info.rb

@@ -19,8 +19,9 @@ module GirFFI
     # Provide the second parameter if the plural is not trivially
     # constructed by adding +s+ to the singular.
     def self.build_array_method method, single = nil
-      single ||= method.to_s[0..-2]
-      count = "n_#{method}"
+      method = method.to_s
+      single ||= method[0..-2]
+      count = method.sub(/^(get_)?/, "\\1n_")
       self.class_eval <<-CODE
 	def #{method}
 	  (0..(#{count} - 1)).map do |i|
@@ -36,7 +37,7 @@ module GirFFI
       Lib.g_base_info_get_name @gobj
     end
 
-    def type
+    def info_type
       Lib.g_base_info_get_type @gobj
     end
 

data/lib/gir_ffi/i_field_info.rb

@@ -5,13 +5,16 @@ module GirFFI
     def flags
       Lib.g_field_info_get_flags @gobj
     end
+
     def size
       Lib.g_field_info_get_size @gobj
     end
+
     def offset
       Lib.g_field_info_get_offset @gobj
     end
-    def type
+
+    def field_type
       ITypeInfo.wrap(Lib.g_field_info_get_type @gobj)
     end
   end

data/lib/gir_ffi/i_interface_info.rb

@@ -20,14 +20,14 @@ module GirFFI
     ##
     build_array_method :properties, :property
 
-    def n_methods
+    def get_n_methods
       Lib.g_interface_info_get_n_methods @gobj
     end
-    def method index
+    def get_method index
       IFunctionInfo.wrap(Lib.g_interface_info_get_method @gobj, index)
     end
     ##
-    build_array_method :methods
+    build_array_method :get_methods
 
     def find_method name
       IFunctionInfo.wrap(Lib.g_interface_info_find_method @gobj, name)

data/lib/gir_ffi/i_object_info.rb

@@ -42,14 +42,16 @@ module GirFFI
     ##
     build_array_method :properties, :property
 
-    def n_methods
+    def get_n_methods
       Lib.g_object_info_get_n_methods @gobj
     end
-    def method(index)
+
+    def get_method(index)
       IFunctionInfo.wrap(Lib.g_object_info_get_method @gobj, index)
     end
+
     ##
-    build_array_method :methods
+    build_array_method :get_methods
 
     def find_method(name)
       IFunctionInfo.wrap(Lib.g_object_info_find_method @gobj, name)

data/lib/gir_ffi/i_struct_info.rb

@@ -12,23 +12,21 @@ module GirFFI
     ##
     build_array_method :fields
 
-    def n_methods
+    def get_n_methods
       Lib.g_struct_info_get_n_methods @gobj
     end
-    def method(index)
+    def get_method(index)
       IFunctionInfo.wrap(Lib.g_struct_info_get_method @gobj, index)
     end
 
     ##
-    build_array_method :methods
-
-    def methods_hash
-      @methods_hash ||= methods.inject({}) {|h,m| h[m.name] = m; h}
-    end
+    build_array_method :get_methods
 
     def find_method(name)
-      methods_hash[name]
+      @methods_hash ||= get_methods.inject({}) {|h,m| h[m.name] = m; h}
+      @methods_hash[name]
     end
+
     def size
       Lib.g_struct_info_get_size @gobj
     end

data/lib/gir_ffi/i_union_info.rb

@@ -9,11 +9,11 @@ module GirFFI
     ##
     build_array_method :fields
 
-    def n_methods; Lib.g_union_info_get_n_methods @gobj; end
-    def method(index); IFunctionInfo.wrap(Lib.g_union_info_get_method @gobj, index); end
+    def get_n_methods; Lib.g_union_info_get_n_methods @gobj; end
+    def get_method(index); IFunctionInfo.wrap(Lib.g_union_info_get_method @gobj, index); end
 
     ##
-    build_array_method :methods
+    build_array_method :get_methods
 
     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

data/lib/gir_ffi/overrides/gobject.rb

@@ -150,18 +150,18 @@ module GirFFI
 	end
 	
 	def self.signal_argument_to_gvalue info, arg
-	  if info.type.tag == :interface
-	    interface = info.type.interface
+	  if info.argument_type.tag == :interface
+	    interface = info.argument_type.interface
 
 	    val = ::GObject::Value.new
-	    val.init info.type.interface.g_type
-	    case interface.type
+	    val.init info.argument_type.interface.g_type
+	    case interface.info_type
 	    when :struct
 	      val.set_boxed arg
 	    when :object
 	      val.set_instance arg
 	    else
-	      raise NotImplementedError, interface.type
+	      raise NotImplementedError, interface.info_type
 	    end
 
 	    return val
@@ -198,8 +198,8 @@ module GirFFI
 	  # Extra arguments
 	  signalinfo.args.each do |info|
 	    arg = args.shift
-	    if info.type.tag == :interface
-	      iface = info.type.interface
+	    if info.argument_type.tag == :interface
+	      iface = info.argument_type.interface
 	      kls = GirFFI::Builder.build_class iface
 	      result << kls.wrap(arg)
 	    else