C Ruby Makefile Shell
Permalink
Failed to load latest commit information.
bench fix tests for netbsd Jul 1, 2014
ext/ffi_c Revert "Do closures via libffi" Jun 3, 2018
gen Keep a log of generated types.conf files Nov 13, 2011
lib adding MacPorts,Fink,etc search path in /opt/local/lib (#638) Jul 3, 2018
libtest Synchronize changes between libtest and spec/ffi/fixtures directories. Aug 6, 2015
nbproject Add custom data converters for parameter and return types May 22, 2010
samples Fix qsort example for 64bit Dec 12, 2009
spec Run rspec with dots output only Jun 2, 2018
.gitignore Fix compatibility with PPC64LE platform (#577) Jul 12, 2017
.gitmodules Fix compatibility with PPC64LE platform (#577) Jul 12, 2017
.travis.yml Various fixes and more deterinistic gem packaging (#612) Feb 12, 2018
.yardopts Don’t explicitly state markdown markup in YARD options Aug 6, 2011
CHANGELOG.md Add reference to CVE-2018-1000201 [ci skip] Jun 24, 2018
COPYING Switch license to BSD throughout codebase. See #288. Oct 29, 2013
Gemfile Bump rake-compiler-dock dependency to add ruby-2.5 support (#599) Jan 23, 2018
LICENSE update license Jul 11, 2016
LICENSE.SPECS Change licensing of the specs to the same license as Rubyspec Nov 25, 2012
README.md Revert "README: Remove now unnecessary PaX workaround [ci skip]" Jun 3, 2018
Rakefile Add a CHANGELOG file Jun 1, 2018
appveyor.yml Various fixes and more deterinistic gem packaging (#612) Feb 12, 2018
ffi.gemspec Various fixes and more deterinistic gem packaging (#612) Feb 12, 2018

README.md

ruby-ffi https://wiki.github.com/ffi/ffi Build Status Build status Windows

Description

Ruby-FFI is a ruby extension for programmatically loading dynamic libraries, binding functions within them, and calling those functions from Ruby code. Moreover, a Ruby-FFI extension works without changes on Ruby and JRuby. Discover why you should write your next extension using Ruby-FFI.

Features/problems

  • Intuitive DSL
  • Supports all C native types
  • C structs (also nested), enums and global variables
  • Callbacks from C to ruby
  • Automatic garbage collection of native memory

Synopsis

require 'ffi'

module MyLib
  extend FFI::Library
  ffi_lib 'c'
  attach_function :puts, [ :string ], :int
end

MyLib.puts 'Hello, World using libc!'

For less minimalistic and more sane examples you may look at:

Requirements

You need a sane building environment in order to compile the extension. At a minimum, you will need:

  • A C compiler (e.g. Xcode on OSX, gcc on everything else)
  • libffi development library - this is commonly in the libffi-dev or libffi-devel

On Linux systems running with PaX (Gentoo, Alpine, etc.) FFI may trigger mprotect errors. You may need to disable mprotect for ruby (paxctl -m [/path/to/ruby]) for the time being until a solution is found.

Installation

From rubygems:

[sudo] gem install ffi

or from the git repository on github:

git clone git://github.com/ffi/ffi.git
git submodule update --init --recursive
cd ffi
rake install

License

The ffi library is covered by the BSD license, also see the LICENSE file. The specs are shared with Rubyspec and are licensed by the same license as Rubyspec, see the LICENSE.SPECS file.

Credits

The following people have submitted code, bug reports, or otherwise contributed to the success of this project: