class GObjectIntrospection::Loader

Attributes

version[RW]

Public Class Methods

load(namespace, base_module, options={}) click to toggle source
# File lib/gobject-introspection/loader.rb, line 20
def load(namespace, base_module, options={})
  loader = new(base_module)
  loader.version = options[:version]
  loader.load(namespace)
end
new(base_module) click to toggle source
# File lib/gobject-introspection/loader.rb, line 28
def initialize(base_module)
  @base_module = base_module
  @version = nil
end

Public Instance Methods

load(namespace) click to toggle source
# File lib/gobject-introspection/loader.rb, line 33
def load(namespace)
  repository = Repository.default
  repository.require(namespace, @version)
  pre_load(repository, namespace)
  repository.each(namespace) do |info|
    load_info(info)
  end
  post_load(repository, namespace)
end

Private Instance Methods

define_boxed(info) click to toggle source
# File lib/gobject-introspection/loader.rb, line 115
def define_boxed(info)
  klass = self.class.define_class(info.gtype, info.name, @base_module)
  # TODO
  # load_fields(info, klass)
  # load_methods(info, klass)
end
define_module_function(target_module, name, function_info) click to toggle source
# File lib/gobject-introspection/loader.rb, line 78
def define_module_function(target_module, name, function_info)
  unlock_gvl = should_unlock_gvl?(function_info, target_module)
  validate = lambda do |arguments|
    method_name = "#{target_module}\#.#{name}"
    validate_arguments(function_info, method_name, arguments)
  end
  target_module.module_eval do
    define_method(name) do |*arguments, &block|
      validate.call(arguments, &block)
      function_info.invoke({
                             :arguments => arguments,
                             :unlock_gvl => unlock_gvl,
                           },
                           &block)
    end
    module_function(name)
  end
end
define_struct(info, options={}) click to toggle source
# File lib/gobject-introspection/loader.rb, line 97
def define_struct(info, options={})
  if info.gtype == GLib::Type::NONE
    klass = self.class.define_struct(info.size, info.name, @base_module,
                                     :parent => options[:parent])
  else
    klass = self.class.define_class(info.gtype, info.name, @base_module,
                                    :parent => options[:parent])
  end
  load_fields(info, klass)
  load_methods(info, klass)
end
find_suitable_callable_info(infos, arguments) click to toggle source
# File lib/gobject-introspection/loader.rb, line 252
def find_suitable_callable_info(infos, arguments)
  min_n_args = nil
  max_n_args = nil
  infos.each do |info|
    if arguments.size == info.n_in_args
      return info
    end
    n_in_args = info.n_in_args
    min_n_args = [min_n_args || n_in_args, n_in_args].min
    max_n_args = [max_n_args || n_in_args, n_in_args].max
  end
  detail = "#{arguments.size} for #{min_n_args}"
  if min_n_args < max_n_args
    detail << "..#{max_n_args}"
  end
  raise ArgumentError, "wrong number of arguments (#{detail})"
end
load_boxed_info(info) click to toggle source
# File lib/gobject-introspection/loader.rb, line 122
def load_boxed_info(info)
  define_boxed(info)
end
load_constant_info(info) click to toggle source
# File lib/gobject-introspection/loader.rb, line 361
def load_constant_info(info)
  @base_module.const_set(info.name, info.value)
end
load_constructor_infos(infos, klass) click to toggle source
# File lib/gobject-introspection/loader.rb, line 207
def load_constructor_infos(infos, klass)
  return if infos.empty?

  validate = lambda do |info, method_name, arguments|
    validate_arguments(info, "#{klass}\##{method_name}", arguments)
  end
  infos.each do |info|
    name = "initialize_#{info.name}"
    unlock_gvl = should_unlock_gvl?(info, klass)
    klass.__send__(:define_method, name) do |*arguments, &block|
      validate.call(info, name, arguments, &block)
      info.invoke({
                    :receiver  => self,
                    :arguments => arguments,
                    :unlock_gvl => unlock_gvl,
                  },
                  &block)
    end
    klass.__send__(:private, name)
  end

  find_info = lambda do |arguments|
    find_suitable_callable_info(infos, arguments)
  end
  klass.__send__(:define_method, "initialize") do |*arguments, &block|
    info = find_info.call(arguments, &block)
    __send__("initialize_#{info.name}", *arguments, &block)
  end
end
load_enum_info(info) click to toggle source
# File lib/gobject-introspection/loader.rb, line 130
def load_enum_info(info)
  if info.gtype == GLib::Type::NONE
    enum_module = Module.new
    info.values.each do |value_info|
      load_enum_value(value_info, enum_module)
    end
    @base_module.const_set(info.name, enum_module)
  else
    self.class.define_class(info.gtype, info.name, @base_module)
  end
end
load_enum_value(value_info, enum_module) click to toggle source
# File lib/gobject-introspection/loader.rb, line 126
def load_enum_value(value_info, enum_module)
  enum_module.const_set(value_info.name.upcase, value_info.value)
end
load_field(info, i, field_info, klass) click to toggle source
# File lib/gobject-introspection/loader.rb, line 171
def load_field(info, i, field_info, klass)
  name = field_info.name
  flags = field_info.flags

  if flags.readable?
    klass.__send__(:define_method, name) do ||
      info.get_field_value(self, i)
    end
  end

  if flags.writable?
    klass.__send__(:define_method, "#{name}=") do |value|
      info.set_field_value(self, i, value)
    end
  end
end
load_fields(info, klass) click to toggle source
# File lib/gobject-introspection/loader.rb, line 164
def load_fields(info, klass)
  info.n_fields.times do |i|
    field_info = info.get_field(i)
    load_field(info, i, field_info, klass)
  end
end
load_flag_value(value_info, flags_module) click to toggle source
# File lib/gobject-introspection/loader.rb, line 142
def load_flag_value(value_info, flags_module)
  flags_module.const_set(value_info.name.upcase, value_info.value)
end
load_flags_info(info) click to toggle source
# File lib/gobject-introspection/loader.rb, line 146
def load_flags_info(info)
  if info.gtype == GLib::Type::NONE
    flags_module = Module.new
    info.values.each do |value_info|
      load_flag_value(value_info, flags_module)
    end
    @base_module.const_set(info.name, flags_module)
  else
    self.class.define_class(info.gtype, info.name, @base_module)
  end
end
load_function_info(info) click to toggle source
# File lib/gobject-introspection/loader.rb, line 73
def load_function_info(info)
  name = rubyish_method_name(info)
  define_module_function(@base_module, name, info)
end
load_function_infos(infos, klass) click to toggle source
# File lib/gobject-introspection/loader.rb, line 330
def load_function_infos(infos, klass)
  infos.each do |info|
    name = rubyish_method_name(info)
    next if name == "new"
    next if name == "alloc"
    unlock_gvl = should_unlock_gvl?(info, klass)
    validate = lambda do |arguments|
      validate_arguments(info, "#{klass}.#{name}", arguments)
    end
    singleton_class = (class << klass; self; end)
    singleton_class.__send__(:define_method, name) do |*arguments, &block|
      validate.call(arguments, &block)
      if block.nil? and info.require_callback?
        Enumerator.new(self, name, *arguments)
      else
        info.invoke({
                      :arguments => arguments,
                      :unlock_gvl => unlock_gvl,
                    },
                    &block)
      end
    end
  end
end
load_info(info) click to toggle source
# File lib/gobject-introspection/loader.rb, line 50
def load_info(info)
  case info
  when FunctionInfo
    load_function_info(info)
  when StructInfo
    load_struct_info(info)
  when BoxedInfo
    load_boxed_info(info)
  when FlagsInfo
    load_flags_info(info)
  when EnumInfo
    load_enum_info(info)
  when ObjectInfo
    load_object_info(info)
  when InterfaceInfo
    load_interface_info(info)
  when ConstantInfo
    load_constant_info(info)
  when UnionInfo
    load_union_info(info)
  end
end
load_interface_info(info) click to toggle source
# File lib/gobject-introspection/loader.rb, line 355
def load_interface_info(info)
  interface_module =
    self.class.define_interface(info.gtype, info.name, @base_module)
  load_methods(info, interface_module)
end
load_method_info(info, klass, method_name) click to toggle source
# File lib/gobject-introspection/loader.rb, line 310
def load_method_info(info, klass, method_name)
  unlock_gvl = should_unlock_gvl?(info, klass)
  validate = lambda do |arguments|
    validate_arguments(info, "#{klass}\##{method_name}", arguments)
  end
  klass.__send__(:define_method, method_name) do |*arguments, &block|
    validate.call(arguments, &block)
    if block.nil? and info.require_callback?
      Enumerator.new(self, method_name, *arguments)
    else
      info.invoke({
                    :receiver  => self,
                    :arguments => arguments,
                    :unlock_gvl => unlock_gvl,
                  },
                  &block)
    end
  end
end
load_method_infos(infos, klass) click to toggle source
# File lib/gobject-introspection/loader.rb, line 300
def load_method_infos(infos, klass)
  infos.each do |info|
    method_name = rubyish_method_name(info)
    load_method_info(info, klass, method_name)
    if /\Aset_/ =~ method_name and info.n_args == 1
      klass.__send__(:alias_method, "#{$POSTMATCH}=", method_name)
    end
  end
end
load_methods(info, klass) click to toggle source
# File lib/gobject-introspection/loader.rb, line 188
def load_methods(info, klass)
  grouped_methods = info.methods.group_by do |method_info|
    method_info.class
  end
  grouped_methods.each do |method_info_class, method_infos|
    next if method_infos.empty?
    case method_infos.first
    when ConstructorInfo
      load_constructor_infos(method_infos, klass)
    when MethodInfo
      load_method_infos(method_infos, klass)
    when FunctionInfo
      load_function_infos(method_infos, klass)
    else
      raise "TODO: #{method_info_class}"
    end
  end
end
load_object_info(info) click to toggle source
# File lib/gobject-introspection/loader.rb, line 158
def load_object_info(info)
  klass = self.class.define_class(info.gtype, info.name, @base_module)
  load_fields(info, klass)
  load_methods(info, klass)
end
load_struct_info(info) click to toggle source
# File lib/gobject-introspection/loader.rb, line 109
def load_struct_info(info)
  return if info.gtype_struct?

  define_struct(info)
end
load_union_info(info) click to toggle source
# File lib/gobject-introspection/loader.rb, line 365
def load_union_info(info)
  klass = self.class.define_class(info.gtype, info.name, @base_module)
  load_fields(info, klass)
  load_methods(info, klass)
end
post_load(repository, namespace) click to toggle source
# File lib/gobject-introspection/loader.rb, line 47
def post_load(repository, namespace)
end
pre_load(repository, namespace) click to toggle source
# File lib/gobject-introspection/loader.rb, line 44
def pre_load(repository, namespace)
end
rubyish_method_name(function_info) click to toggle source
# File lib/gobject-introspection/loader.rb, line 270
def rubyish_method_name(function_info)
  name = function_info.name
  return_type = function_info.return_type
  if return_type.tag == GObjectIntrospection::TypeTag::BOOLEAN
    case name
    when /\A(?:is|get_is|get)_/
      "#{$POSTMATCH}?"
    when /\A(?:has|use)_/
      "#{name}?"
    else
      name
    end
  elsif /\Aget_/ =~ name and function_info.n_in_args.zero?
    $POSTMATCH
  else
    case name
    when "to_string"
      "to_s"
    when "foreach"
      "each"
    else
      name
    end
  end
end
should_unlock_gvl?(function_info, klass) click to toggle source
# File lib/gobject-introspection/loader.rb, line 296
def should_unlock_gvl?(function_info, klass)
  false
end
validate_arguments(info, method_name, arguments) click to toggle source
# File lib/gobject-introspection/loader.rb, line 237
def validate_arguments(info, method_name, arguments)
  n_in_args = info.n_in_args
  n_required_in_args = info.n_required_in_args
  return if (n_required_in_args..n_in_args).cover?(arguments.size)

  detail = "#{arguments.size} for "
  if n_in_args == n_required_in_args
    detail << "#{info.n_in_args}"
  else
    detail << "#{info.n_required_in_args}..#{info.n_in_args}"
  end
  message = "#{method_name}: wrong number of arguments (#{detail})"
  raise ArgumentError, message
end