gir_ffi 0.0.1

data/lib/gir_ffi/i_signal_info.rb

@@ -0,0 +1,7 @@
+module GirFFI
+  # Wraps a GISignalInfo struct.
+  # Represents a signal.
+  # Not implemented yet.
+  class ISignalInfo < IBaseInfo
+  end
+end

data/lib/gir_ffi/i_struct_info.rb

@@ -0,0 +1,22 @@
+module GirFFI
+  # Wraps a GIStructInfo struct.
+  # Represents a struct.
+  class IStructInfo < IRegisteredTypeInfo
+    def n_fields; Lib.g_struct_info_get_n_fields @gobj; end
+    def field(index); IFieldInfo.wrap(Lib.g_struct_info_get_field @gobj, index); end
+
+    ##
+    build_array_method :fields
+
+    def n_methods; Lib.g_struct_info_get_n_methods @gobj; end
+    def method(index); IFunctionInfo.wrap(Lib.g_struct_info_get_method @gobj, index); end
+
+    ##
+    build_array_method :methods
+
+    def find_method(name); IFunctionInfo.wrap(Lib.g_struct_info_find_method @gobj, name); end
+    def size; Lib.g_struct_info_get_size @gobj; end
+    def alignment; Lib.g_struct_info_get_alignment @gobj; end
+    def gtype_struct?; Lib.g_struct_info_is_gtype_struct @gobj; end
+  end
+end

data/lib/gir_ffi/i_type_info.rb

@@ -0,0 +1,25 @@
+module GirFFI
+  # Wraps a GITypeInfo struct.
+  # Represents type information, direction, transfer etc.
+  class ITypeInfo < IBaseInfo
+    def pointer?; Lib.g_type_info_is_pointer @gobj; end
+    def tag; Lib.g_type_info_get_tag @gobj; end
+    def param_type(index); ITypeInfo.wrap(Lib.g_type_info_get_param_type @gobj, index); end
+    def interface
+      ptr = Lib.g_type_info_get_interface @gobj
+      IRepository.wrap_ibaseinfo_pointer ptr
+    end
+    def array_length; Lib.g_type_info_get_array_length @gobj; end
+    def array_fixed_size; Lib.g_type_info_get_array_fixed_size @gobj; end
+    def zero_terminated?; Lib.g_type_info_is_zero_terminated @gobj; end
+    def n_error_domains; Lib.g_type_info_get_n_error_domains @gobj; end
+    def error_domain(index); IErrorDomainInfo.wrap(Lib.g_type_info_get_error_domain @gobj, index); end
+    ##
+    build_array_method :error_domains
+
+    def name
+      raise "Should not call this for gir 0.6.5 ..."
+    end
+  end
+end
+

data/lib/gir_ffi/i_union_info.rb

@@ -0,0 +1,7 @@
+module GirFFI
+  # Wraps a GIUnionInfo struct.
+  # Represents a union.
+  # Not implemented yet.
+  class IUnionInfo < IRegisteredTypeInfo
+  end
+end

data/lib/gir_ffi/i_value_info.rb

@@ -0,0 +1,8 @@
+module GirFFI
+  # Wraps a GIValueInfo struct.
+  # Represents one of the enum values of an IEnumInfo.
+  class IValueInfo < IBaseInfo
+    def value; Lib.g_value_info_get_value @gobj; end
+  end
+end
+

data/lib/gir_ffi/i_vfunc_info.rb

@@ -0,0 +1,7 @@
+module GirFFI
+  # Wraps a GIVFuncInfo struct.
+  # Represents a virtual function.
+  # Not implemented yet.
+  class IVFuncInfo < IBaseInfo
+  end
+end

data/lib/gir_ffi/lib.rb

@@ -0,0 +1,174 @@
+require 'ffi'
+
+module GirFFI
+  module Lib
+    extend FFI::Library
+    ffi_lib "girepository-1.0"
+
+    # IRepository
+    enum :IRepositoryLoadFlags, [:LAZY, (1<<0)]
+
+    attach_function :g_irepository_get_default, [], :pointer
+    attach_function :g_irepository_require,
+      [:pointer, :string, :string, :IRepositoryLoadFlags, :pointer],
+      :pointer
+    attach_function :g_irepository_get_n_infos, [:pointer, :string], :int
+    attach_function :g_irepository_get_info,
+      [:pointer, :string, :int], :pointer
+    attach_function :g_irepository_find_by_name,
+      [:pointer, :string, :string], :pointer
+    attach_function :g_irepository_get_shared_library,
+      [:pointer, :string], :string
+
+    # IBaseInfo
+    enum :IInfoType, [
+      :invalid,
+      :function,
+      :callback,
+      :struct,
+      :boxed,
+      :enum,
+      :flags,
+      :object,
+      :interface,
+      :constant,
+      :error_domain,
+      :union,
+      :value,
+      :signal,
+      :vfunc,
+      :property,
+      :field,
+      :arg,
+      :type,
+      :unresolved
+    ]
+
+    attach_function :g_base_info_get_type, [:pointer], :IInfoType
+    attach_function :g_base_info_get_name, [:pointer], :string
+    attach_function :g_base_info_get_namespace, [:pointer], :string
+    attach_function :g_base_info_is_deprecated, [:pointer], :bool
+    attach_function :g_base_info_equal, [:pointer, :pointer], :bool
+
+    # IFunctionInfo
+    attach_function :g_function_info_get_symbol, [:pointer], :string
+    # TODO: return type is bitfield
+    attach_function :g_function_info_get_flags, [:pointer], :int
+
+    # ICallableInfo
+    enum :ITransfer, [
+      :nothing,
+      :container,
+      :everything
+    ]
+
+    attach_function :g_callable_info_get_return_type, [:pointer], :pointer
+    attach_function :g_callable_info_get_caller_owns, [:pointer], :ITransfer
+    attach_function :g_callable_info_may_return_null, [:pointer], :bool
+    attach_function :g_callable_info_get_n_args, [:pointer], :int
+    attach_function :g_callable_info_get_arg, [:pointer, :int], :pointer
+
+    # IArgInfo
+    enum :IDirection, [
+      :in,
+      :out,
+      :inout
+    ]
+
+    enum :IScopeType, [
+      :invalid,
+      :call,
+      :async,
+      :notified
+    ]
+
+    attach_function :g_arg_info_get_direction, [:pointer], :IDirection
+    attach_function :g_arg_info_is_return_value, [:pointer], :bool
+    attach_function :g_arg_info_is_optional, [:pointer], :bool
+    attach_function :g_arg_info_may_be_null, [:pointer], :bool
+    attach_function :g_arg_info_get_ownership_transfer, [:pointer], :ITransfer
+    attach_function :g_arg_info_get_scope, [:pointer], :IScopeType
+    attach_function :g_arg_info_get_closure, [:pointer], :int
+    attach_function :g_arg_info_get_destroy, [:pointer], :int
+    attach_function :g_arg_info_get_type, [:pointer], :pointer
+
+    # The values of ITypeTag were changed in an incompatible way between
+    # gobject-introspection version 0.9.0 and 0.9.1. Therefore, we need to
+    # retrieve the correct values before declaring the ITypeTag enum.
+    attach_function :tmp_type_tag_to_string, :g_type_tag_to_string, [:int], :string
+    arr = (0..31).map { |i| [tmp_type_tag_to_string(i).to_sym, i] }.flatten
+    enum :ITypeTag, arr
+
+    # Now, attach g_type_tag_to_string again under its own name with an
+    # improved signature.
+    attach_function :g_type_tag_to_string, [:ITypeTag], :string
+
+    #define G_TYPE_TAG_IS_BASIC(tag) (tag < GI_TYPE_TAG_ARRAY)
+
+    attach_function :g_type_info_is_pointer, [:pointer], :bool
+    attach_function :g_type_info_get_tag, [:pointer], :ITypeTag
+    attach_function :g_type_info_get_param_type, [:pointer, :int], :pointer
+    attach_function :g_type_info_get_interface, [:pointer], :pointer
+    attach_function :g_type_info_get_array_length, [:pointer], :int
+    attach_function :g_type_info_get_array_fixed_size, [:pointer], :int
+    attach_function :g_type_info_is_zero_terminated, [:pointer], :bool
+    attach_function :g_type_info_get_n_error_domains, [:pointer], :int
+    attach_function :g_type_info_get_error_domain, [:pointer, :int], :pointer
+
+    # IStructInfo
+    attach_function :g_struct_info_get_n_fields, [:pointer], :int
+    attach_function :g_struct_info_get_field, [:pointer, :int], :pointer
+    attach_function :g_struct_info_get_n_methods, [:pointer], :int
+    attach_function :g_struct_info_get_method, [:pointer, :int], :pointer
+    attach_function :g_struct_info_find_method, [:pointer, :string], :pointer
+    attach_function :g_struct_info_get_size, [:pointer], :int
+    attach_function :g_struct_info_get_alignment, [:pointer], :int
+    attach_function :g_struct_info_is_gtype_struct, [:pointer], :bool
+
+    # IValueInfo
+    attach_function :g_value_info_get_value, [:pointer], :long
+
+    # IFieldInfo
+    enum :IFieldInfoFlags, [
+      :readable, (1 << 0),
+      :writable, (1 << 1)
+    ]
+    attach_function :g_field_info_get_flags, [:pointer], :IFieldInfoFlags
+    attach_function :g_field_info_get_size, [:pointer], :int
+    attach_function :g_field_info_get_offset, [:pointer], :int
+    attach_function :g_field_info_get_type, [:pointer], :pointer
+
+    # IUnionInfo
+    # IStructInfo
+    # IRegisteredTypeInfo
+
+    # IEnumInfo
+    attach_function :g_enum_info_get_storage_type, [:pointer], :ITypeTag
+    attach_function :g_enum_info_get_n_values, [:pointer], :int
+    attach_function :g_enum_info_get_value, [:pointer, :int], :pointer
+
+    # IObjectInfo
+    attach_function :g_object_info_get_type_name, [:pointer], :string
+    attach_function :g_object_info_get_type_init, [:pointer], :string
+    attach_function :g_object_info_get_abstract, [:pointer], :bool
+    attach_function :g_object_info_get_parent, [:pointer], :pointer
+    attach_function :g_object_info_get_n_interfaces, [:pointer], :int
+    attach_function :g_object_info_get_interface, [:pointer, :int], :pointer
+    attach_function :g_object_info_get_n_fields, [:pointer], :int
+    attach_function :g_object_info_get_field, [:pointer, :int], :pointer
+    attach_function :g_object_info_get_n_properties, [:pointer], :int
+    attach_function :g_object_info_get_property, [:pointer, :int], :pointer
+    attach_function :g_object_info_get_n_methods, [:pointer], :int
+    attach_function :g_object_info_get_method, [:pointer, :int], :pointer
+    attach_function :g_object_info_find_method, [:pointer, :string], :pointer
+    attach_function :g_object_info_get_n_signals, [:pointer], :int
+    attach_function :g_object_info_get_signal, [:pointer, :int], :pointer
+    attach_function :g_object_info_get_n_vfuncs, [:pointer], :int
+    attach_function :g_object_info_get_vfunc, [:pointer, :int], :pointer
+    attach_function :g_object_info_find_vfunc, [:pointer, :string], :pointer
+    attach_function :g_object_info_get_n_constants, [:pointer], :int
+    attach_function :g_object_info_get_constant, [:pointer, :int], :pointer
+    attach_function :g_object_info_get_class_struct, [:pointer], :pointer
+
+  end
+end

data/lib/gir_ffi/lib_c.rb

@@ -0,0 +1,11 @@
+require 'ffi'
+
+module GirFFI
+  module LibC
+    extend FFI::Library
+    ffi_lib FFI::Library::LIBC
+    
+    attach_function :malloc, [:size_t], :pointer
+    attach_function :free, [:pointer], :void
+  end
+end

data/lib/gir_ffi/method_missing_definition_builder.rb

@@ -0,0 +1,62 @@
+module GirFFI
+  # Base class for builders of #method_missing definitions.
+  class MethodMissingDefinitionBuilder
+    def initialize lib, namespace
+      @lib = lib
+      @namespace = namespace
+    end
+
+    def generate
+      args = arguments.map {|arg| "\"#{arg}\""}
+
+      return <<-CODE
+	def #{slf}method_missing method, *arguments, &block
+	  result = GirFFI::Builder.#{fn} #{args.join ', '}, #{libs.join ', '}, self, method.to_s
+	  return super unless result
+	  if block.nil?
+	    self.send method, *arguments
+	  else
+	    self.send method, *arguments, &block
+	  end
+	end
+      CODE
+    end
+  end
+
+  # Builds a #method_missing for a module. This method_missing will be
+  # called for missing module methods; these modules are not meant for
+  # #include'ing.
+  class ModuleMethodMissingDefinitionBuilder < MethodMissingDefinitionBuilder
+    private
+
+    def slf; "self."; end
+    def fn; "setup_function"; end
+    def arguments; [@namespace]; end
+    def libs; [@lib]; end
+  end
+
+  # Builds a #method_missing for missing instance methods.
+  class InstanceMethodMissingDefinitionBuilder < MethodMissingDefinitionBuilder
+    def initialize lib, modul, namespace, classname
+      super lib, namespace
+      @classname = classname
+      @module = modul
+    end
+
+    private
+
+    def slf; ""; end
+    def fn; "setup_method"; end
+    def arguments; [@namespace, @classname]; end
+    def libs; [@lib, @module]; end
+  end
+
+  # Builds a #method_missing for missing class methods.
+  class ClassMethodMissingDefinitionBuilder < InstanceMethodMissingDefinitionBuilder
+    private
+
+    def slf; "self."; end
+  end
+
+end
+

data/lib/gir_ffi/module_builder.rb

@@ -0,0 +1,66 @@
+require 'gir_ffi/builder_helper'
+
+module GirFFI
+  # Builds a module based on information found in the introspection
+  # repository.
+  class ModuleBuilder
+
+    def initialize namespace, box
+      @namespace = namespace
+      @box = box
+    end
+
+    def generate
+      build_module
+    end
+
+    private
+
+    def build_module
+      IRepository.default.require @namespace, nil
+      setup_module
+      setup_lib_for_ffi
+      unless @module.respond_to? :method_missing
+	@module.class_eval module_method_missing_definition
+	@module.class_eval const_missing_definition
+      end
+      @module
+    end
+
+    def setup_module
+      if @box.nil?
+	boxm = ::Object
+      else
+	boxm = BuilderHelper.get_or_define_module ::Object, @box.to_s
+      end
+      @module = BuilderHelper.get_or_define_module boxm, @namespace.to_s
+    end
+
+    def setup_lib_for_ffi
+      @lib = BuilderHelper.get_or_define_module @module, :Lib
+
+      unless (class << @lib; self.include? FFI::Library; end)
+	@lib.extend FFI::Library
+	libs = IRepository.default.shared_library(@namespace).split(/,/)
+	@lib.ffi_lib(*libs)
+      end
+
+      BuilderHelper.optionally_define_constant(@lib, :CALLBACKS) { [] }
+    end
+
+    def module_method_missing_definition
+      ModuleMethodMissingDefinitionBuilder.new(@lib, @namespace).generate
+    end
+
+    def const_missing_definition
+      box = @box.nil? ? "nil" : "\"#{@box}\""
+      return <<-CODE
+	def self.const_missing classname
+	  info = IRepository.default.find_by_name "#{@namespace}", classname.to_s
+	  return super if info.nil?
+	  return GirFFI::Builder.build_class "#{@namespace}", classname.to_s, #{box}
+	end
+      CODE
+    end
+  end
+end

data/lib/gir_ffi/overrides/gtk.rb

@@ -0,0 +1,12 @@
+GirFFI::Builder.setup_function "Gtk", Gtk::Lib, Gtk, "init"
+module Gtk
+  class << self
+    alias _base_init init
+    def init
+      (my_len, my_args) = _base_init ARGV.length + 1, [$0, *ARGV]
+      my_args.shift
+      ARGV.replace my_args
+    end
+    private :_base_init
+  end
+end

data/lib/gir_ffi/version.rb

@@ -0,0 +1,4 @@
+module GirFFI
+  VERSION = "0.0.1"
+end
+

data/tasks/bones.rake

@@ -0,0 +1,87 @@
+# The following code is copied straight from Bones 2.5.1
+#
+require 'pp'
+require 'stringio'
+
+module Bones
+
+# Helper module that will pretty print OpenStruct objects. It is used mainly
+# for debugging the Mr Bones project open struct.
+#
+module Debug
+
+  # :stopdoc:
+  KEY_LENGTH = 20
+  VAR_LENGTH = 78 - 6 - KEY_LENGTH
+  SEP = "\n" + ' '*(KEY_LENGTH+6)
+  FMT = "  %-#{KEY_LENGTH}s => %s"
+  # :startdoc:
+
+  # Print all the keys for the given _ostruct_ to stdout. If a _prefix_ is
+  # given, then the open struct keys will be prefixed with this string.
+  #
+  def self.show( ostruct, prefix = '' )
+    sio = StringIO.new
+
+    h = ostruct.instance_variable_get(:@table)
+    h.keys.map {|k| k.to_s}.sort.each do |k|
+      sio.seek 0
+      sio.truncate 0
+      next if k =~ %r/^_/o
+
+      val = h[k.to_sym]
+      if val.instance_of?(OpenStruct)
+        self.show(val, prefix + k + '.')
+      else
+        PP.pp(val, sio, VAR_LENGTH)
+        sio.seek 0
+        val = sio.read
+        val = val.split("\n").join(SEP)
+
+        key = prefix + k
+        key[(KEY_LENGTH-3)..-1] = '...' if key.length > KEY_LENGTH
+        puts(FMT % [key, val])
+      end
+    end
+  end
+
+  # Print a single attribute from the given _ostruct_ to stdout. The
+  # attributed is identified by the given _key_.
+  #
+  def self.show_attr( ostruct, key )
+    sio = StringIO.new
+
+    key = key.dup if key.frozen?
+    val = key.split('.').inject(ostruct) {|os,k| os.send(k)}
+
+    if val.instance_of?(OpenStruct)
+      self.show(val, key + '.')
+    else
+      PP.pp(val, sio, VAR_LENGTH)
+      sio.seek 0
+      val = sio.read
+      val = val.split("\n").join(SEP)
+
+      key[(KEY_LENGTH-3)..-1] = '...' if key.length > KEY_LENGTH
+      puts(FMT % [key, val])
+    end
+  end
+
+end  # module Debug
+end  # module Bones
+
+namespace :bones do
+
+  desc 'Show the PROJ open struct'
+  task :debug do |t|
+    atr = if t.application.top_level_tasks.length == 2
+      t.application.top_level_tasks.pop
+    end
+
+    if atr then Bones::Debug.show_attr(PROJ, atr)
+    else Bones::Debug.show PROJ end
+  end
+
+end  # namespace :bones
+
+# EOF