class GirFFI::InOutPointer

The InOutPointer class handles conversion between ruby types and pointers for arguments with direction :inout and :out.

TODO: This has now become a more general extended pointer class and should be renamed.

Attributes

value_type[R]

Public Class Methods

for(type) click to toggle source
# File lib/gir_ffi/in_out_pointer.rb, line 58
def self.for(type)
  new(type).tap(&:clear)
end
from(type, value) click to toggle source
# File lib/gir_ffi/in_out_pointer.rb, line 62
def self.from(type, value)
  new(type).tap { |ptr| ptr.set_value value }
end
new(type, ptr = nil) click to toggle source
Calls superclass method
# File lib/gir_ffi/in_out_pointer.rb, line 9
def initialize(type, ptr = nil)
  @value_type = type

  ptr ||= AllocationHelper.safe_malloc(value_type_size)
  super ptr
end

Public Instance Methods

clear() click to toggle source
# File lib/gir_ffi/in_out_pointer.rb, line 54
def clear
  put_bytes 0, "\x00" * value_type_size, 0, value_type_size
end
set_value(value) click to toggle source
# File lib/gir_ffi/in_out_pointer.rb, line 43
def set_value(value)
  case value_ffi_type
  when Module
    value_ffi_type.copy_value_to_pointer(value, self)
  when Symbol
    send "put_#{value_ffi_type}", 0, value
  else
    raise NotImplementedError, value_ffi_type
  end
end
to_ruby_value() click to toggle source

Convert more fully to a ruby value than to_value

# File lib/gir_ffi/in_out_pointer.rb, line 29
def to_ruby_value
  bare_value = to_value
  case value_type
  when :utf8
    bare_value.to_utf8
  when Array
    value_type[1].wrap bare_value
  when Class
    value_type.wrap bare_value
  else
    bare_value
  end
end
to_value() click to toggle source

TODO: Create type classes that extract values from pointers.

# File lib/gir_ffi/in_out_pointer.rb, line 17
def to_value
  case value_ffi_type
  when Module
    value_ffi_type.get_value_from_pointer(self, 0)
  when Symbol
    send("get_#{value_ffi_type}", 0)
  else
    raise NotImplementedError
  end
end

Private Instance Methods

value_ffi_type() click to toggle source
# File lib/gir_ffi/in_out_pointer.rb, line 68
def value_ffi_type
  @value_ffi_type ||= TypeMap.type_specification_to_ffi_type value_type
end
value_type_size() click to toggle source
# File lib/gir_ffi/in_out_pointer.rb, line 72
def value_type_size
  @value_type_size ||= FFI.type_size value_ffi_type
end