FFI

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 Evan Phoenix 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.

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 Evan Phoenix nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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 Evan Phoenix nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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 Evan Phoenix nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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 Evan Phoenix nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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 Evan Phoenix nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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 Evan Phoenix nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

Public Class Methods

add_typedef(current, add) click to toggle source

TypeDefs = Hash.new

    # File lib/ffi/types.rb, line 32
32:   def self.add_typedef(current, add)
33:     if current.kind_of?(FFI::Type)
34:       code = current
35:     else
36:       code = TypeDefs[current]
37:       raise TypeError, "Unable to resolve type '#{current}'" unless code
38:     end
39: 
40:     TypeDefs[add] = code
41:   end

create_invoker(lib, name, args, ret_type, options = { :convention => :default }) click to toggle source

    # File lib/ffi/ffi.rb, line 71
71:   def self.create_invoker(lib, name, args, ret_type, options = { :convention => :default })
72:     # Current artificial limitation based on JRuby::FFI limit
73:     raise SignatureError, 'FFI functions may take max 32 arguments!' if args.size > 32
74: 
75:     # Open the library if needed
76:     library = if lib.kind_of?(DynamicLibrary)
77:       lib
78:     elsif lib.kind_of?(String)
79:       # Allow FFI.create_invoker to be  called with a library name
80:       DynamicLibrary.open(FFI.map_library_name(lib), DynamicLibrary::RTLD_LAZY)
81:     elsif lib.nil?
82:       FFI::Library::DEFAULT
83:     else
84:       raise LoadError, "Invalid library '#{lib}'"
85:     end
86:     function = library.find_function(name)
87:     raise NotFoundError.new(name, library.name) unless function
88: 
89:     args = args.map {|e| find_type(e) }
90:     invoker = if args.length > 0 && args[args.length - 1] == FFI::NativeType::VARARGS
91:       FFI::VariadicInvoker.new(function, args, find_type(ret_type), options)
92:     else
93:       FFI::Function.new(find_type(ret_type), args, function, options)
94:     end
95:     raise NotFoundError.new(name, library.name) unless invoker
96: 
97:     return invoker
98:   end

errno() click to toggle source

   # File lib/ffi/errno.rb, line 2
2:   def self.errno
3:     FFI::LastError.error
4:   end

errno=(error) click to toggle source

   # File lib/ffi/errno.rb, line 5
5:   def self.errno=(error)
6:     FFI::LastError.error = error
7:   end

find_type(name, type_map = nil) click to toggle source

    # File lib/ffi/types.rb, line 42
42:   def self.find_type(name, type_map = nil)
43:     type_map = TypeDefs if type_map.nil?
44:     code = type_map[name]
45:     code = name if !code && name.kind_of?(FFI::Type)
46:     raise TypeError, "Unable to resolve type '#{name}'" unless code
47:     return code
48:   end

map_library_name(lib) click to toggle source

    # File lib/ffi/ffi.rb, line 58
58:   def self.map_library_name(lib)
59:     # Mangle the library name to reflect the native library naming conventions
60:     lib = lib.to_s unless lib.kind_of?(String)
61:     lib = Platform::LIBC if Platform::IS_LINUX && lib == 'c'
62:     if lib && File.basename(lib) == lib
63:       ext = ".#{Platform::LIBSUFFIX}"
64:       lib = Platform::LIBPREFIX + lib unless lib =~ /^#{Platform::LIBPREFIX}/
65:       lib += ext unless lib =~ /#{ext}/
66:     end
67:     lib
68:   end

size_to_type(size) click to toggle source

     # File lib/ffi/types.rb, line 154
154:   def self.size_to_type(size)
155:     if sz = TypeSizes[size]
156:       return sz
157:     end
158: 
159:     # Be like C, use int as the default type size.
160:     return :int
161:   end

type_size(type) click to toggle source

     # File lib/ffi/types.rb, line 162
162:   def self.type_size(type)
163:     if sz = SizeTypes[find_type(type)]
164:       return sz
165:     end
166:     raise ArgumentError, "Unknown native type"
167:   end

Home Classes Methods

In Files

Namespace

Methods

Files

Class Index

FFI

Constants

Public Class Methods