123456789_123456789_123456789_123456789_123456789_

Module: FFI

Overview

Copyright © 2008-2010 Wayne Meissner Copyright © 2008, 2009 Andrea Fazzi Copyright © 2008, 2009 Luc Heinrich

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.

Constant Summary

Class Attribute Summary

Class Method Summary

Class Attribute Details

.errno (rw)

[ GitHub ] 

  


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



def self.errno
  FFI::LastError.error
end


  








  

    .errno=(error)   (rw)
  



  

    
  





    
See Also:

  



  [ GitHub ]


  

  


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



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


  







Class Method Details



  

    .__typedef(old, add)  
  

  [ GitHub ]


  

  


# File 'lib/ffi/types.rb', line 66



private def __typedef(old, add)
  TypeDefs[add] = find_type(old, TypeDefs)
end


  








  

    .add_typedef(old, add)  ⇒ Type 
  



  

    

Add a definition type to type definitions.



The type definition is local per Ractor.


  





  
Parameters:





  [ GitHub ]


  

  


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



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


  








  

    .custom_typedefs   (mod_func)
  



  

    

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


  



  [ GitHub ]


  

  


# File 'ext/ffi_c/Type.c', line 258



static VALUE
custom_typedefs(VALUE self)
{
#if HAVE_RB_EXT_RACTOR_SAFE
    VALUE hash = rb_ractor_local_storage_value(custom_typedefs_key);
    if (hash == Qnil) {
        hash = rb_hash_new();
        rb_ractor_local_storage_value_set(custom_typedefs_key, hash);
    }
#else
    static VALUE hash = Qundef;
    if (hash == Qundef) {
        rb_global_variable(&hash);
        hash = rb_hash_new();
    }
#endif
    return hash;
}


  








  

    .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 ::FFI::DataConverter, a new ::FFI::Type::Mapped is created.


  





  
Parameters:





  [ GitHub ]


  

  


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



  

    

This is for FFI internal use only.



See additional method definition at line 35.


  



  [ GitHub ]


  

  


# File 'lib/ffi/compat.rb', line 39



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
    

    
  
    • 





  [ GitHub ]


  

  


# 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
    

    
  
    • 





  [ GitHub ]


  

  


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





  [ GitHub ]


  

  


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



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