Module FFI
In: lib/ffi/version.rb
lib/ffi/variadic.rb
lib/ffi/union.rb
lib/ffi/types.rb
lib/ffi/tools/types_generator.rb
lib/ffi/tools/struct_generator.rb
lib/ffi/tools/generator.rb
lib/ffi/tools/const_generator.rb
lib/ffi/struct_layout_builder.rb
lib/ffi/struct.rb
lib/ffi/pointer.rb
lib/ffi/platform.rb
lib/ffi/managedstruct.rb
lib/ffi/library.rb
lib/ffi/io.rb
lib/ffi/errno.rb
lib/ffi/enum.rb
lib/ffi/autopointer.rb

Copyright (C) 2008-2010 Wayne Meissner Copyright (C) 2008 Mike Dalessio

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.

Methods

Classes and Modules

Module FFI::Generator
Module FFI::IO
Module FFI::Library
Module FFI::Platform
Class FFI::AutoPointer
Class FFI::ConstGenerator
Class FFI::Enum
Class FFI::Enums
Class FFI::Generator
Class FFI::ManagedStruct
Class FFI::NotFoundError
Class FFI::PlatformError
Class FFI::Pointer
Class FFI::StrPtrConverter
Class FFI::Struct
Class FFI::StructGenerator
Class FFI::StructLayout
Class FFI::StructLayoutBuilder
Class FFI::TypesGenerator
Class FFI::Union
Class FFI::VariadicInvoker

Constants

VERSION = '1.9.10'
ARCH = case CPU.downcase
CURRENT_PROCESS = USE_THIS_PROCESS_AS_LIBRARY = Object.new

Public Class methods

@return (see FFI::LastError.error) @see FFI::LastError.error

@param error (see FFI::LastError.error=) @return (see FFI::LastError.error=) @see FFI::LastError.error=

@param [Type, DataConverter, Symbol] name @param [Hash] type_map if nil, {FFI::TypeDefs} is used @return [Type] Find a type in type_map ({FFI::TypeDefs}, by default) from a type objet, a type name (symbol). If name is a {DataConverter}, a new {Type::Mapped} is created.

@param [to_s] lib library name @return [String] library name formatted for current platform Transform a generic library name to a platform library name @example

 # 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"

@param type type is an instance of class accepted by {FFI.find_type} @return [Numeric] Get type size, in bytes.

@param [Type, DataConverter, Symbol] old type definition used by {FFI.find_type} @param [Symbol] add new type definition‘s name to add @return [Type] Add a definition type to type definitions.

[Validate]