Module: FFI

Defined in:
lib/ffi/io.rb,
lib/ffi/enum.rb,
lib/ffi/errno.rb,
lib/ffi/types.rb,
lib/ffi/union.rb,
lib/ffi/compat.rb,
lib/ffi/struct.rb,
lib/ffi/library.rb,
lib/ffi/pointer.rb,
lib/ffi/version.rb,
lib/ffi/function.rb,
lib/ffi/platform.rb,
lib/ffi/variadic.rb,
lib/ffi/autopointer.rb,
lib/ffi/library_path.rb,
lib/ffi/managedstruct.rb,
lib/ffi/struct_layout.rb,
lib/ffi/data_converter.rb,
lib/ffi/abstract_memory.rb,
lib/ffi/dynamic_library.rb,
lib/ffi/tools/generator.rb,
lib/ffi/struct_by_reference.rb,
lib/ffi/struct_layout_builder.rb,
lib/ffi/tools/const_generator.rb,
lib/ffi/tools/types_generator.rb,
lib/ffi/tools/struct_generator.rb

Overview

Copyright © 2008-2010 Wayne Meissner

This file is part of ruby-ffi.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the Ruby FFI project nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Defined Under Namespace

Modules: DataConverter, IO, Library, Platform Classes: AbstractMemory, AutoPointer, Bitmask, ConstGenerator, DynamicLibrary, Enum, Enums, Function, Generator, LibraryPath, ManagedStruct, NotFoundError, PlatformError, Pointer, StrPtrConverter, Struct, StructByReference, StructGenerator, StructLayout, StructLayoutBuilder, TypesGenerator, Union, VariadicInvoker

Constant Summary collapse

CURRENT_PROCESS = 
USE_THIS_PROCESS_AS_LIBRARY = FFI.make_shareable(Object.new)
VERSION = 
'1.17.0'

Class Method Summary collapse

Class Method Details

.add_typedef(old, add) ⇒ Type

Add a definition type to type definitions.

The type definition is local per Ractor.

Parameters:

  • old (Type, DataConverter, Symbol) —

    type definition used by find_type

  • add (Symbol) —

    new type definition’s name to add

Returns:

  • (Type) 


62
63
64
 
# File 'lib/ffi/types.rb', line 62

def add_typedef(old, add)
  typedef old, add
end

.custom_typedefs ⇒ Object

Truffleruby and JRuby don’t support Ractor so far. So they don’t need separation between builtin and custom types.



40
41
42
 
# File 'lib/ffi/types.rb', line 40

def self.custom_typedefs
  TypeDefs
end

.errno ⇒ Object

See Also:

  • FFI::LastError.error


34
35
36
 
# File 'lib/ffi/errno.rb', line 34

def self.errno
  FFI::LastError.error
end

.errno=(error) ⇒ Object

See Also:

  • FFI::LastError.error=


40
41
42
 
# File 'lib/ffi/errno.rb', line 40

def self.errno=(error)
  FFI::LastError.error = error
end

.find_type(name, type_map = nil) ⇒ Type

Find a type in type_map (TypeDefs, by default) from a type objet, a type name (symbol). If name is a DataConverter, a new Type::Mapped is created.

Parameters:

  • name (Type, DataConverter, Symbol)
  • type_map (Hash) (defaults to: nil) —

    if nil, TypeDefs is used

Returns:

  • (Type) 


76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/ffi/types.rb', line 76

def find_type(name, type_map = nil)
  if name.is_a?(Type)
    name

  elsif type_map&.has_key?(name)
    type_map[name]

  elsif (tm=custom_typedefs).has_key?(name)
    tm[name]

  elsif TypeDefs.has_key?(name)
    TypeDefs[name]

  elsif name.is_a?(DataConverter)
    # Add a typedef so next time the converter is used, it hits the cache
    tm = (type_map || custom_typedefs)
    tm[name] = Type::Mapped.new(name)
  else
    raise TypeError, "unable to resolve type '#{name}'"
  end
end

.make_shareable(obj) ⇒ Object

This is for FFI internal use only.



35
36
37
 
# File 'lib/ffi/compat.rb', line 35

def self.make_shareable(obj)
  Ractor.make_shareable(obj)
end

.map_library_name(lib) ⇒ String

Transform a generic library name to a platform library name

Examples:

# Linux
FFI.map_library_name 'c'     # -> "libc.so.6"
FFI.map_library_name 'jpeg'  # -> "libjpeg.so"
# Windows
FFI.map_library_name 'c'     # -> "msvcrt.dll"
FFI.map_library_name 'jpeg'  # -> "jpeg.dll"

Parameters:

Returns:

  • (String) —

    library name formatted for current platform



46
47
48
49
 
# File 'lib/ffi/library.rb', line 46

def self.map_library_name(lib)
  # Mangle the library name to reflect the native library naming conventions
  LibraryPath.wrap(lib).to_s
end

.type_size(type) ⇒ Integer

Get type size, in bytes.

Parameters:

  • type —

    type is an instance of class accepted by find_type

Returns:

  • (Integer) 


101
102
103
 
# File 'lib/ffi/types.rb', line 101

def type_size(type)
  find_type(type).size
end

.typedef(old, add) ⇒ Type

Add a definition type to type definitions.

The type definition is local per Ractor.

Parameters:

  • old (Type, DataConverter, Symbol) —

    type definition used by find_type

  • add (Symbol) —

    new type definition’s name to add

Returns:

  • (Type) 


56
57
58
59
 
# File 'lib/ffi/types.rb', line 56

def typedef(old, add)
  tm = custom_typedefs
  tm[add] = find_type(old)
end