gir_ffi 0.0.1

data/lib/gir_ffi/constructor_definition_builder.rb

@@ -0,0 +1,20 @@
+module GirFFI
+  # Implements the creation of a Ruby constructor definition out of a GIR
+  # IFunctionInfo, if it represents a constructor.
+  class ConstructorDefinitionBuilder < FunctionDefinitionBuilder
+    private
+
+    def process_return_value
+    end
+
+    def filled_out_template
+      return <<-CODE
+	def #{@info.name} #{@inargs.join(', ')}
+	  #{@pre.join("\n")}
+	  _real_new #{@libmodule}.#{@info.symbol}(#{@callargs.join(', ')})
+	end
+      CODE
+    end
+  end
+end
+

data/lib/gir_ffi/function_definition_builder.rb

@@ -0,0 +1,148 @@
+module GirFFI
+  # Implements the creation of a Ruby function definition out of a GIR
+  # IFunctionInfo.
+  class FunctionDefinitionBuilder
+    KEYWORDS =  [
+      "alias", "and", "begin", "break", "case", "class", "def", "do",
+      "else", "elsif", "end", "ensure", "false", "for", "if", "in",
+      "module", "next", "nil", "not", "or", "redo", "rescue", "retry",
+      "return", "self", "super", "then", "true", "undef", "unless",
+      "until", "when", "while", "yield"
+    ]
+
+    def initialize info, libmodule
+      @info = info
+      @libmodule = libmodule
+    end
+
+    def generate
+      setup_accumulators
+      process_return_value
+      @info.args.each {|a| process_arg a}
+      adjust_accumulators
+      return filled_out_template
+    end
+
+    private
+
+    def setup_accumulators
+      @inargs = []
+      @callargs = []
+      @retvals = []
+
+      @pre = []
+      @post = []
+
+      @capture = ""
+
+      @varno = 0
+    end
+
+    def process_arg arg
+      case arg.direction
+      when :inout
+	process_inout_arg arg
+      when :in
+	process_in_arg arg
+      else
+	raise NotImplementedError
+      end
+    end
+
+    def process_inout_arg arg
+      raise NotImplementedError unless arg.ownership_transfer == :everything
+
+      name = safe arg.name
+      prevar = new_var
+      postvar = new_var
+
+      @inargs << name
+      case arg.type.tag
+      when :int, :int32
+	@pre << "#{prevar} = GirFFI::ArgHelper.int_to_inoutptr #{name}"
+	@post << "#{postvar} = GirFFI::ArgHelper.outptr_to_int #{prevar}"
+      when :array
+	case arg.type.param_type(0).tag
+	when :utf8
+	  @pre << "#{prevar} = GirFFI::ArgHelper.string_array_to_inoutptr #{name}"
+	  @post << "#{postvar} = GirFFI::ArgHelper.outptr_to_string_array #{prevar}, #{name}.nil? ? 0 : #{name}.size"
+	else
+	  raise NotImplementedError
+	end
+      else
+	raise NotImplementedError
+      end
+      @callargs << prevar
+      @retvals << postvar
+    end
+
+    def process_in_arg arg
+      name = safe arg.name
+      type = arg.type
+      tag = type.tag
+
+      @inargs << name
+
+      if tag == :interface and type.interface.type == :callback
+	# TODO: Use arg.scope to decide if this is needed.
+	procvar = new_var
+	@pre << "#{procvar} = GirFFI::ArgHelper.mapped_callback_args #{name}"
+	@pre << "#{@libmodule}::CALLBACKS << #{procvar}"
+	@callargs << procvar
+      elsif tag == :void
+	raise NotImplementedError unless arg.type.pointer?
+	prevar = new_var
+	@pre << "#{prevar} = GirFFI::ArgHelper.object_to_inptr #{name}"
+	@callargs << prevar
+      else
+	@callargs << name
+      end
+    end
+
+    def process_return_value
+      type = @info.return_type
+      tag = type.tag
+      return if tag == :void
+      retval = new_var
+      @capture = "#{retval} = "
+
+      if tag == :interface
+	interface = type.interface
+	@retvals << "#{interface.namespace}::#{interface.name}._real_new(#{retval})"
+      else
+	@retvals << retval
+      end
+    end
+
+    def adjust_accumulators
+      @post << "return #{@retvals.join(', ')}" unless @retvals.empty?
+
+      if @info.method?
+	@callargs.unshift "self"
+      end
+    end
+
+    def filled_out_template
+      return <<-CODE
+	def #{@info.name} #{@inargs.join(', ')}
+	  #{@pre.join("\n")}
+	  #{@capture}#{@libmodule}.#{@info.symbol} #{@callargs.join(', ')}
+	  #{@post.join("\n")}
+	end
+      CODE
+    end
+
+    def new_var
+      @varno += 1
+      "_v#{@varno}"
+    end
+
+    def safe name
+      if KEYWORDS.include? name
+	"#{name}_"
+      else
+	name
+      end
+    end
+  end
+end

data/lib/gir_ffi/g_error.rb

@@ -0,0 +1,8 @@
+module GirFFI
+  # Wraps GObject's GError struct.
+  class GError < FFI::Struct
+    layout :domain, :uint32,
+      :code, :int,
+      :message, :string
+  end
+end

data/lib/gir_ffi/g_type.rb

@@ -0,0 +1,14 @@
+require 'ffi'
+
+module GirFFI
+  module GType
+    def self.init; Lib::g_type_init; end
+    module Lib
+      extend FFI::Library
+      ffi_lib "gobject-2.0"
+      attach_function :g_type_init, [], :void
+    end
+  end
+end
+
+

data/lib/gir_ffi/i_arg_info.rb

@@ -0,0 +1,16 @@
+require 'gir_ffi/i_base_info'
+module GirFFI
+  # Wraps a GIArgInfo struct.
+  # Represents an argument.
+  class IArgInfo < IBaseInfo
+    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 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; ITypeInfo.wrap(Lib.g_arg_info_get_type @gobj); end
+  end
+end

data/lib/gir_ffi/i_base_info.rb

@@ -0,0 +1,45 @@
+require 'gir_ffi/class_base'
+
+module GirFFI
+  # Wraps GIBaseInfo struct, the base \type for all info types.
+  # Decendant types will be implemented as needed.
+  class IBaseInfo
+    include ClassBase
+
+    # This is a helper method to construct a method returning an array, out
+    # of the methods returning their number and the individual elements.
+    #
+    # For example, given the methods +n_foos+ and +foo+(+i+), this method
+    # will create an additional method +foos+ returning all args.
+    #
+    # 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}"
+      self.class_eval <<-CODE
+	def #{method}
+	  (0..(#{count} - 1)).map do |i|
+	    #{single} i
+	  end
+	end
+      CODE
+    end
+
+    private_class_method :new
+
+    def name; Lib.g_base_info_get_name @gobj; end
+    def type; Lib.g_base_info_get_type @gobj; end
+    def namespace; Lib.g_base_info_get_namespace @gobj; end
+    def deprecated?; Lib.g_base_info_is_deprecated @gobj; end
+
+    def self.wrap ptr
+      return nil if ptr.null?
+      return new ptr
+    end
+
+    def == other
+      Lib.g_base_info_equal @gobj, other.to_ptr
+    end
+  end
+end

data/lib/gir_ffi/i_callable_info.rb

@@ -0,0 +1,18 @@
+require 'gir_ffi/i_base_info'
+require 'gir_ffi/i_type_info'
+require 'gir_ffi/i_arg_info'
+
+module GirFFI
+  # Wraps a GICallableInfo struct; represents a callable, either
+  # IFunctionInfo, ICallbackInfo or IVFuncInfo.
+  class ICallableInfo < IBaseInfo
+    def return_type; ITypeInfo.wrap(Lib.g_callable_info_get_return_type @gobj); end
+    def caller_owns; Lib.g_callable_info_get_caller_owns @gobj; end
+    def may_return_null?; Lib.g_callable_info_may_return_null @gobj; end
+    def n_args; Lib.g_callable_info_get_n_args @gobj; end
+    def arg(index); IArgInfo.wrap(Lib.g_callable_info_get_arg @gobj, index); end
+    ##
+    build_array_method :args
+  end
+end
+

data/lib/gir_ffi/i_callback_info.rb

@@ -0,0 +1,7 @@
+module GirFFI
+  # Wraps a GICallbackInfo struct. Has no methods in addition to the onese
+  # inherited from ICallableInfo.
+  class ICallbackInfo < ICallableInfo
+  end
+end
+

data/lib/gir_ffi/i_constant_info.rb

@@ -0,0 +1,6 @@
+module GirFFI
+  # Wraps a GIConstantInfo struct; represents an constant.
+  # Not implemented yet.
+  class IConstantInfo < IBaseInfo
+  end
+end

data/lib/gir_ffi/i_enum_info.rb

@@ -0,0 +1,13 @@
+module GirFFI
+  # Wraps a GIEnumInfo struct if it represents an enum.
+  # If it represents a flag, an IFlagsInfo object is used instead.
+  class IEnumInfo < IRegisteredTypeInfo
+    def n_values; Lib.g_enum_info_get_n_values @gobj; end
+    def value(index); IValueInfo.wrap(Lib.g_enum_info_get_value @gobj, index); end
+    ##
+    build_array_method :values
+
+    def storage_type; Lib.g_enum_info_get_storage_type @gobj; end
+  end
+end
+

data/lib/gir_ffi/i_field_info.rb

@@ -0,0 +1,10 @@
+module GirFFI
+  # Wraps a GIFieldInfo struct.
+  # Represents a field of an IStructInfo or an IUnionInfo.
+  class IFieldInfo < IBaseInfo
+    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; ITypeInfo.wrap(Lib.g_field_info_get_type @gobj); end
+  end
+end

data/lib/gir_ffi/i_flags_info.rb

@@ -0,0 +1,5 @@
+module GirFFI
+  # Wraps a GIEnumInfo struct, if it represents a flag type.
+  class IFlagsInfo < IEnumInfo
+  end
+end

data/lib/gir_ffi/i_function_info.rb

@@ -0,0 +1,16 @@
+module GirFFI
+  # Wraps a GIFunctioInfo struct.
+  # Represents a function.
+  class IFunctionInfo < ICallableInfo
+    def symbol; Lib.g_function_info_get_symbol @gobj; end
+    def flags; Lib.g_function_info_get_flags @gobj; end
+
+    #TODO: Use some sort of bitfield
+    def method?; flags & 1 != 0 end
+    def constructor?; flags & 2 != 0 end
+    def getter?; flags & 4 != 0 end
+    def setter?; flags & 8 != 0 end
+    def wraps_vfunc?; flags & 16 != 0 end
+    def throws?; flags & 32 != 0 end
+  end
+end

data/lib/gir_ffi/i_interface_info.rb

@@ -0,0 +1,7 @@
+module GirFFI
+  # Wraps a GIInterfaceInfo struct.
+  # Represents an interface.
+  # Not implemented yet.
+  class IInterfaceInfo < IRegisteredTypeInfo
+  end
+end

data/lib/gir_ffi/i_object_info.rb

@@ -0,0 +1,50 @@
+module GirFFI
+  # Wraps a GIObjectInfo struct.
+  # Represents an object.
+  class IObjectInfo < IRegisteredTypeInfo
+    def type_name; Lib.g_object_info_get_type_name @gobj; end
+    def type_init; Lib.g_object_info_get_type_init @gobj; end
+    def abstract?; Lib.g_object_info_get_abstract @gobj; end
+    def parent; IObjectInfo.wrap(Lib.g_object_info_get_parent @gobj); end
+
+    def n_interfaces; Lib.g_object_info_get_n_interfaces @gobj; end
+    def interface(index); IInterfaceInfo.wrap(Lib.g_object_info_get_interface @gobj, index); end
+    ##
+    build_array_method :interfaces
+
+    def n_fields; Lib.g_object_info_get_n_fields @gobj; end
+    def field(index); IFieldInfo.wrap(Lib.g_object_info_get_field @gobj, index); end
+    ##
+    build_array_method :fields
+
+    def n_properties; Lib.g_object_info_get_n_properties @gobj; end
+    def property(index); IPropertyInfo.wrap(Lib.g_object_info_get_property @gobj, index); end
+    ##
+    build_array_method :properties, :property
+
+    def n_methods; Lib.g_object_info_get_n_methods @gobj; end
+    def method(index); IFunctionInfo.wrap(Lib.g_object_info_get_method @gobj, index); end
+    ##
+    build_array_method :methods
+
+    def find_method(name); IFunctionInfo.wrap(Lib.g_object_info_find_method @gobj, name); end
+
+    def n_signals; Lib.g_object_info_get_n_signals @gobj; end
+    def signal(index); ISignalInfo.wrap(Lib.g_object_info_get_signal @gobj, index); end
+    ##
+    build_array_method :signals
+
+    def n_vfuncs; Lib.g_object_info_get_n_vfuncs @gobj; end
+    def vfunc(index); IVFuncInfo.wrap(Lib.g_object_info_get_vfunc @gobj, index); end
+    def find_vfunc; IVFuncInfo.wrap(Lib.g_object_info_find_vfunc @gobj); end
+    ##
+    build_array_method :vfuncs
+
+    def n_constants; Lib.g_object_info_get_n_constants @gobj; end
+    def constant(index); IConstantInfo.wrap(Lib.g_object_info_get_constant @gobj, index); end
+    ##
+    build_array_method :constants
+
+    def class_struct; IStructInfo.wrap(Lib.g_object_info_get_class_struct @gobj); end
+  end
+end

data/lib/gir_ffi/i_property_info.rb

@@ -0,0 +1,7 @@
+module GirFFI
+  # Wraps a GIPropertyInfo struct.
+  # Represents a property of an IObjectInfo or an IInterfaceInfo.
+  # Not implemented yet.
+  class IPropertyInfo < IBaseInfo
+  end
+end

data/lib/gir_ffi/i_registered_type_info.rb

@@ -0,0 +1,8 @@
+module GirFFI
+  # Wraps a GIRegisteredTypeInfo struct.
+  # Represents a registered type.
+  # Not implemented yet.
+  class IRegisteredTypeInfo < IBaseInfo
+  end
+end
+

data/lib/gir_ffi/i_repository.rb

@@ -0,0 +1,108 @@
+require 'singleton'
+require 'gir_ffi/lib'
+require 'gir_ffi/g_type'
+require 'gir_ffi/g_error'
+require 'gir_ffi/i_base_info'
+require 'gir_ffi/i_callable_info'
+require 'gir_ffi/i_callback_info'
+require 'gir_ffi/i_function_info'
+require 'gir_ffi/i_constant_info'
+require 'gir_ffi/i_field_info'
+require 'gir_ffi/i_registered_type_info'
+require 'gir_ffi/i_interface_info'
+require 'gir_ffi/i_property_info'
+require 'gir_ffi/i_vfunc_info'
+require 'gir_ffi/i_signal_info'
+require 'gir_ffi/i_object_info'
+require 'gir_ffi/i_struct_info'
+require 'gir_ffi/i_value_info'
+require 'gir_ffi/i_union_info'
+require 'gir_ffi/i_enum_info'
+require 'gir_ffi/i_flags_info'
+
+module GirFFI
+  # The Gobject Introspection Repository. This class is the point of
+  # access to the introspection typelibs.
+  # This class wraps the GIRepository struct.
+  class IRepository
+    TYPEMAP = {
+      #:invalid,
+      :function => IFunctionInfo,
+      :callback => ICallbackInfo,
+      :struct => IStructInfo,
+      #:boxed => ,
+      :enum => IEnumInfo,
+      :flags => IFlagsInfo,
+      :object => IObjectInfo,
+      :interface => IInterfaceInfo,
+      :constant => IConstantInfo,
+      # :error_domain,
+      :union => IUnionInfo,
+      :value => IValueInfo,
+      :signal => ISignalInfo,
+      :vfunc => IVFuncInfo,
+      :property => IPropertyInfo,
+      :field => IFieldInfo,
+      :arg => IArgInfo,
+      :type => ITypeInfo,
+      #:unresolved
+    }
+
+    def initialize
+      GType.init
+      @gobj = Lib::g_irepository_get_default
+    end
+
+    include Singleton
+
+    def self.default
+      self.instance
+    end
+
+    def self.type_tag_to_string type
+      Lib.g_type_tag_to_string type
+    end
+
+    def n_infos namespace
+      Lib.g_irepository_get_n_infos @gobj, namespace
+    end
+
+    def require namespace, version
+      errpp = FFI::MemoryPointer.new(:pointer).write_pointer nil
+
+      Lib.g_irepository_require @gobj, namespace, version, 0, errpp
+
+      errp = errpp.read_pointer
+      raise GError.new(errp)[:message] unless errp.null?
+    end
+
+    def info namespace, index
+      ptr = Lib.g_irepository_get_info @gobj, namespace, index
+      return wrap ptr
+    end
+
+    def find_by_name namespace, name
+      ptr = Lib.g_irepository_find_by_name @gobj, namespace, name
+      return wrap ptr
+    end
+
+    def shared_library namespace
+      Lib.g_irepository_get_shared_library @gobj, namespace
+    end
+
+    def self.wrap_ibaseinfo_pointer ptr
+      return nil if ptr.null?
+
+      type = Lib.g_base_info_get_type ptr
+      klass = TYPEMAP[type]
+
+      return klass.wrap(ptr)
+    end
+
+    private
+
+    def wrap ptr
+      IRepository.wrap_ibaseinfo_pointer ptr
+    end
+  end
+end