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) ⇒ Object 



65
66
67
 
# File 'lib/gir_ffi/callback_base.rb', line 65

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

.from(prc) ⇒ Object

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



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

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

.from_native(value, _context) ⇒ Object 



15
16
17
18
19
 
# File 'lib/gir_ffi/callback_base.rb', line 15

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) ⇒ Object 



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

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

.native_type ⇒ Object 



11
12
13
 
# File 'lib/gir_ffi/callback_base.rb', line 11

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

.store_callback(prc) ⇒ Object 



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

def self.store_callback prc
  CALLBACKS << prc
end

.to_ffitype ⇒ Object 



53
54
55
 
# File 'lib/gir_ffi/callback_base.rb', line 53

def self.to_ffitype
  self
end

.to_native(value, _context) ⇒ Object 



21
22
23
24
25
 
# File 'lib/gir_ffi/callback_base.rb', line 21

def self.to_native value, _context
  return nil unless value
  return value if FFI::Function === value
  value.to_native
end

.wrap(ptr) ⇒ Object 



27
28
29
 
# File 'lib/gir_ffi/callback_base.rb', line 27

def self.wrap ptr
  from_native ptr, nil
end

.wrap_in_callback_args_mapper(prc) ⇒ Object 



45
46
47
48
49
50
51
 
# File 'lib/gir_ffi/callback_base.rb', line 45

def self.wrap_in_callback_args_mapper prc
  return nil unless prc
  return prc if FFI::Function === prc
  new do |*args|
    call_with_argument_mapping(prc, *args)
  end
end

Instance Method Details

#to_native ⇒ Object 



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

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