Class: GirFFI::CallbackBase

Inherits:
Proc
  • Object
show all
Extended by:
FFI::DataConverter, TypeBase
Defined in:
lib/gir_ffi/callback_base.rb

Overview

Base module for callbacks and vfuncs. NOTE: Another option would be to derive this class from FFI::Function, allowing a more natural implementation of from_native, to_native and wrap.

Constant Summary collapse

CALLBACKS = 
{}

Class Method Summary collapse

Instance Method Summary collapse

Methods included from TypeBase

gir_ffi_builder, gir_info

Class Method Details

.copy_value_to_pointer(value, pointer, offset = 0) ⇒ Object 



84
85
86
 
# File 'lib/gir_ffi/callback_base.rb', line 84

def self.copy_value_to_pointer(value, pointer, offset = 0)
  pointer.put_pointer offset, to_native(value, nil)
end

.drop_callback(prc) ⇒ Object 



44
45
46
 
# File 'lib/gir_ffi/callback_base.rb', line 44

def self.drop_callback(prc)
  CALLBACKS.delete prc.object_id
end

.from(prc) ⇒ Object

Create Callback from a Proc. Makes sure arguments are properly wrapped, and the callback is stored to prevent garbage collection.



50
51
52
53
54
 
# File 'lib/gir_ffi/callback_base.rb', line 50

def self.from(prc)
  wrap_proc(prc).tap do |cb|
    store_callback cb
  end
end

.from_native(value, _context) ⇒ Object

TODO: Return instance of this class



18
19
20
21
22
23
 
# File 'lib/gir_ffi/callback_base.rb', line 18

def self.from_native(value, _context)
  return nil if !value || value.null?

  FFI::Function.new(gir_ffi_builder.return_ffi_type,
                    gir_ffi_builder.argument_ffi_types, value)
end

.get_value_from_pointer(pointer, offset) ⇒ Object 



88
89
90
 
# File 'lib/gir_ffi/callback_base.rb', line 88

def self.get_value_from_pointer(pointer, offset)
  from_native pointer.get_pointer(offset), nil
end

.native_type ⇒ Object 



13
14
15
 
# File 'lib/gir_ffi/callback_base.rb', line 13

def self.native_type
  FFI::Type::POINTER
end

.store_callback(prc) ⇒ Object 



40
41
42
 
# File 'lib/gir_ffi/callback_base.rb', line 40

def self.store_callback(prc)
  CALLBACKS[prc.object_id] = prc
end

.to_ffi_type ⇒ Object 



68
69
70
 
# File 'lib/gir_ffi/callback_base.rb', line 68

def self.to_ffi_type
  self
end

.to_native(value, _context) ⇒ Object 



25
26
27
28
29
30
31
32
 
# File 'lib/gir_ffi/callback_base.rb', line 25

def self.to_native(value, _context)
  case value
  when CallbackBase
    value.to_native
  when FFI::Function
    value
  end
end

.wrap(ptr) ⇒ Object 



34
35
36
 
# File 'lib/gir_ffi/callback_base.rb', line 34

def self.wrap(ptr)
  from_native ptr, nil
end

.wrap_proc(prc) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/gir_ffi/callback_base.rb', line 56

def self.wrap_proc(prc)
  return unless prc

  new do |*args|
    begin
      call_with_argument_mapping(prc, *args)
    rescue StandardError => e
      GLib::MainLoop.handle_exception e
    end
  end
end

Instance Method Details

#to_native ⇒ Object 



72
73
74
75
76
77
78
 
# File 'lib/gir_ffi/callback_base.rb', line 72

def to_native
  @to_native ||= begin
                   builder = self.class.gir_ffi_builder
                   FFI::Function.new(builder.return_ffi_type,
                                     builder.argument_ffi_types, self)
                 end
end

#to_ptr ⇒ Object 



80
81
82
 
# File 'lib/gir_ffi/callback_base.rb', line 80

def to_ptr
  to_native.to_ptr
end