neelance / ffi_gen Goto Github PK
View Code? Open in Web Editor NEWA generator for Ruby FFI bindings, directly from header files via LLVM's Clang compiler
License: MIT License
ffi_gen's People
Stargazers
Watchers
Forkers
jvoorhis novogrammer sempervictus daddye jbreeden ghazel windwiny connorhd pombredanne unn4m3d bithium kevin-klein ffi headius thoughtafter katsu33 robforsffi_gen's Issues
can't tokenize last macro in file
foo.h
#define FOO 123
#define BAR 456require "ffi/gen"
FFI::Gen.generate(
module_name: "foo",
ffi_lib: "foo",
headers: ["foo.h"],
cflags: `/usr/local/Cellar/llvm/3.4.1/bin/llvm-config --cflags`.split(" "),
prefixes: [],
output: "foo.rb"Result:
# Generated by ffi-gen. Please do not change this file by hand.
require 'ffi'
module foo
extend FFI::Library
ffi_lib 'foo'
def self.attach_function(name, *_)
begin; super; rescue FFI::NotFoundError => e
(class << self; self; end).class_eval { define_method(name) { |*_| raise e } }
end
end
FOO = 123
endBAR is nowhere to be found.
Maybe related:
http://lists.cs.uiuc.edu/pipermail/cfe-dev/2011-January/012983.html
enum fails to parse (in `block in read_declaration': undefined method `raw' for nil:NilClass (NoMethodError))
#pragma GCC visibility push(default)
enum fun {
FOO,
BAR
};
#pragma GCC visibility pop/Library/Ruby/Gems/2.0.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:379:in `block in read_declaration': undefined method `raw' for nil:NilClass (NoMethodError)
from /Library/Ruby/Gems/2.0.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:372:in `each'
from /Library/Ruby/Gems/2.0.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:372:in `read_declaration'
from /Library/Ruby/Gems/2.0.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:346:in `block in declarations'
from /Library/Ruby/Gems/2.0.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:338:in `each'
from /Library/Ruby/Gems/2.0.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:338:in `each_with_index'
from /Library/Ruby/Gems/2.0.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:338:in `declarations'
from /Library/Ruby/Gems/2.0.0/gems/ffi_gen-1.2.0/lib/ffi_gen/ruby_output.rb:10:in `block in generate_rb'
from /Library/Ruby/Gems/2.0.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:150:in `indent'
from /Library/Ruby/Gems/2.0.0/gems/ffi_gen-1.2.0/lib/ffi_gen/ruby_output.rb:5:in `generate_rb'
from /Library/Ruby/Gems/2.0.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:280:in `generate'
from /Library/Ruby/Gems/2.0.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:749:in `generate'
from foo.rb:3:in `<main>'
Support /* */ comments
Is it possible to support /* */ comments?
For example you can see libssh2.h :)
java generator doesn't output getFieldOrder
getFieldOrder is required: http://twall.github.io/jna/3.5.1/javadoc/com/sun/jna/Structure.html
ffi_gen-1.2.0/lib/ffi_gen.rb:451:in `read_declaration': unhandled exception
child[:kind] in this case is :unexposed_attr
"No translation for values of type 114" on clang-3.5
Can be fixed by regenerating bindings and changing ruby_output.rb:79:
+ when :incomplete_array
+ element_type_data = to_ruby_type Clang.get_array_element_type(canonical_type)
+ [":pointer", "Array<#{element_type_data[:description]}>"]Documentation for getting started on OSX w/Hombrew?
I'm having trouble getting started using this tool on OSX:
LoadError: Could not open library 'libclang-3.5.so.1': dlopen(libclang-3.5.so.1, 5): image not found.
Could not open library 'libclang-3.5.so.1.dylib': dlopen(libclang-3.5.so.1.dylib, 5): image not found.
Could not open library 'libclang.so.1': dlopen(libclang.so.1, 5): image not found.
Could not open library 'libclang.so.1.dylib': dlopen(libclang.so.1.dylib, 5): image not found.
Could not open library 'clang': dlopen(clang, 5): image not found.
Could not open library 'libclang.dylib': dlopen(libclang.dylib, 5): image not found
I have installed llvm via: brew install llvm --with-clang on El Capitan, what am I missing?
Why is this gem available as ffi_gen, not ffi-gen?
Could you fix gemfile and readme to ffi_gen ?
Add a Dockerfile to make testing reproducible
This is necessary, as tests require a nontrivial set of external libraries, which aren't necessarily available on systems such as OS X.
See the discussion in #20 (comment).
Generate seperate files for each Struct/Union
It would be handy to generate separate files for each FFI::Struct / FFI::Union. This would reduce the size of the primary generated file.
Minor issues with libcouchbase
I had to edit some code for the generator to work and not sure what the effect of my code changes are, hence why this isn't a pull request
On OSX, I cloned libcouchbase and built it as per the instructions on that repo
Then I run the following in irb:
require "ffi_gen"
FFIGen.generate(
module_name: "Libcouchbase::Ext",
ffi_lib: "libcouchbase",
headers: ["./include/libcouchbase/couchbase.h"],
# Needed the header stdarg.h which I found on my system here
cflags: ["-I/System/Library/Frameworks/Kernel.framework/Versions/A/Headers"],
prefixes: ["LCB_", "lcb_"],
output: "libcouchbase.rb"
)The following code had errors:
# NoMethodError: undefined method `parts' for nil:NilClass
# from /Users/steve/.rvm/gems/ruby-2.1.5/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:447:in `read_declaration'
# -- I fixed ffi_gen.rb:447 by adding the && name
last_nested_declaration.name ||= Name.new(name.parts + field_name.parts) if last_nested_declaration && namethen
# NoMethodError: undefined method `to_ruby_classname' for nil:NilClass
# from /Users/steve/.rvm/gems/ruby-2.1.5/gems/ffi_gen-1.2.0/lib/ffi_gen/ruby_output.rb:134:in `ruby_name'
# -- I fixed ruby_output.rb:134 by adding the check for nil
@ruby_name ||= @name ? @name.to_ruby_classname : nilHopefully you find this useful and thanks for creating this awesome gem!
libuv won't generate
Trying to generate libuv, but with no luck
require 'ffi_gen'
FFIGen.generate(
module_name: "LibUV",
ffi_lib: "libuv",
headers: %w[
uv.h
],
cflags: `llvm-config --cflags`.split(" "),
prefixes: [],
output: "libuv.rb"
)with llvm-3.5.0_2 installed on Yosemite
here is backtrace
/Users/fazibear/.rubies/2.2.0/lib/ruby/gems/2.2.0/gems/ffi_gen-1.1.0/lib/ffi_gen.rb:328:in `block (2 levels) in read_named_declaration': undefined method `+' for nil:NilClass (NoMethodError)
from /Users/fazibear/.rubies/2.2.0/lib/ruby/gems/2.2.0/gems/ffi_gen-1.1.0/lib/ffi_gen.rb:319:in `catch'
from /Users/fazibear/.rubies/2.2.0/lib/ruby/gems/2.2.0/gems/ffi_gen-1.1.0/lib/ffi_gen.rb:319:in `block in read_named_declaration'
from /Users/fazibear/.rubies/2.2.0/lib/ruby/gems/2.2.0/gems/ffi_gen-1.1.0/lib/ffi_gen.rb:311:in `each'
from /Users/fazibear/.rubies/2.2.0/lib/ruby/gems/2.2.0/gems/ffi_gen-1.1.0/lib/ffi_gen.rb:311:in `read_named_declaration'
from /Users/fazibear/.rubies/2.2.0/lib/ruby/gems/2.2.0/gems/ffi_gen-1.1.0/lib/ffi_gen.rb:295:in `block in declarations'
from /Users/fazibear/.rubies/2.2.0/lib/ruby/gems/2.2.0/gems/ffi_gen-1.1.0/lib/ffi_gen.rb:282:in `each'
from /Users/fazibear/.rubies/2.2.0/lib/ruby/gems/2.2.0/gems/ffi_gen-1.1.0/lib/ffi_gen.rb:282:in `declarations'
from /Users/fazibear/.rubies/2.2.0/lib/ruby/gems/2.2.0/gems/ffi_gen-1.1.0/lib/ffi_gen/ruby_output.rb:10:in `block in generate_rb'
from /Users/fazibear/.rubies/2.2.0/lib/ruby/gems/2.2.0/gems/ffi_gen-1.1.0/lib/ffi_gen.rb:146:in `indent'
from /Users/fazibear/.rubies/2.2.0/lib/ruby/gems/2.2.0/gems/ffi_gen-1.1.0/lib/ffi_gen/ruby_output.rb:5:in `generate_rb'
from /Users/fazibear/.rubies/2.2.0/lib/ruby/gems/2.2.0/gems/ffi_gen-1.1.0/lib/ffi_gen.rb:238:in `generate'
from /Users/fazibear/.rubies/2.2.0/lib/ruby/gems/2.2.0/gems/ffi_gen-1.1.0/lib/ffi_gen.rb:479:in `generate'
Some definitions are ignored
I tried to generate .rb from libssh2.h (http://libssh2.org/download/libssh2-1.4.2.tar.gz)
But some definitions and macros are ignored.
Configuration for generation:
FFI::Gen.generate(
module_name: "LibSSH2",
ffi_lib: "libssh2",
headers: ["libssh2/include/libssh2.h"],
cflags: `llvm-config --cflags`.split(" "),
prefixes: ["libssh2_", "LIBSSH2"],
output: "libssh2/libssh2.rb"
)
For example the following definitions were ignored:
#define LIBSSH2_CHANNEL_WINDOW_DEFAULT (256*1024)
#define libssh2_channel_open_session(session) \
libssh2_channel_open_ex((session), "session", sizeof("session") - 1, \
LIBSSH2_CHANNEL_WINDOW_DEFAULT, \
LIBSSH2_CHANNEL_PACKET_DEFAULT, NULL, 0)
extern "C" definitions
It doesn't look like FFI-Gen currently generates bindings for functions defined inside extern "C" {} blocks.
ncurses won't generate
I'm not sure what I'm doing wrong, but I get an error while ffi-gen is trying to traverse declarations (I think). Here's my gen file:
require 'ffi/gen'
FFI::Gen.generate(
module_name: "Ncurses",
ffi_lib: "ncurses",
headers: ["/usr/include/ncurses.h"],
cflags: `/usr/local/Cellar/llvm/3.4.2/bin/llvm-config --cflags`.split(" "),
prefixes: ["_nc_", "NCURSES_", "WA_", "COLOR_", "ACS_"],
output: "ffi-ncurses.rb")And here's the error I get running it:
~/projects/ffi-gen $ jruby -Ilib ncurses.rb
TypeError: wrong argument type NilClass (expected instance of FFI::Struct)
declarations at /Users/headius/projects/ffi-gen/lib/ffi/gen.rb:327
generate_rb at /Users/headius/projects/ffi-gen/lib/ffi/gen/ruby_output.rb:10
indent at /Users/headius/projects/ffi-gen/lib/ffi/gen.rb:150
generate_rb at /Users/headius/projects/ffi-gen/lib/ffi/gen/ruby_output.rb:5
generate at /Users/headius/projects/ffi-gen/lib/ffi/gen.rb:280
generate at /Users/headius/projects/ffi-gen/lib/ffi/gen.rb:742
(root) at ncurses.rb:3
java generator doesn't output struct member names
JNA struct members appear without names:
public static class Blob extends Structure {
public NativeLong ;
public Pointer ;
}
The code says:
@fields.each do |field|
writer.puts "public #{field[:type].java_jna_type} #{field[:symbol]};"
endI believe it should be something like:
@fields.each do |field|
writer.puts "public #{field[:type].java_jna_type} #{field[:name].raw};"
endSupport generating types.rb
I like to put all typedef, callback and enum definitions in a types.rb file. I can then require the types.rb in other files containing FFI::Struct classes.
flexible arrays (char x[]) incorrectly translate as :pointer
struct foo {
int length;
char data[];
}Translates as:
class Foo < FFI::Struct
layout :length, :int,
:data, :pointer
endHowever, this is incorrect. Data is not a pointer in the sense that memcpy(&f->data, bad, sizeof(void*)) would populate bad with the pointer value. It would instead copy the first sizeof(void*) bytes of the array. Thus, ffi gets a pointer with the first few bytes of the array as the value, which is invalid to dereference.
TypeError: unable to resolve type '[:double, 16]'
It appears that FFI lacks the support for [typ, length] syntax in some contexts.
See ffi/ffi#385.
Defined constant with type indication generates invalid ruby code
Example:
#define CONST_X 0Lis converted to
CONST_X = 0LI'm using version ffi_gen (1.2.0)
Fails for LLVM 4+
This project is probably dead but I believe it is still worth reporting that that it fails for LLVM 3.9, 4.0, and 5.0. LLVM-3.8 works. It fails with the following stack trace when processing Core.h:
SyntaxError: (eval):1: syntax error, unexpected tCONSTANT, expecting end-of-input
/var/lib/gems/2.3.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:401:in `eval'
/var/lib/gems/2.3.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:401:in `block in read_declaration'
/var/lib/gems/2.3.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:372:in `each'
/var/lib/gems/2.3.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:372:in `read_declaration'
/var/lib/gems/2.3.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:346:in `block in declarations'
/var/lib/gems/2.3.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:338:in `each'
/var/lib/gems/2.3.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:338:in `each_with_index'
/var/lib/gems/2.3.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:338:in `declarations'
/var/lib/gems/2.3.0/gems/ffi_gen-1.2.0/lib/ffi_gen/ruby_output.rb:10:in `block in generate_rb'
/var/lib/gems/2.3.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:150:in `indent'
/var/lib/gems/2.3.0/gems/ffi_gen-1.2.0/lib/ffi_gen/ruby_output.rb:5:in `generate_rb'
/var/lib/gems/2.3.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:280:in `generate'
/var/lib/gems/2.3.0/gems/ffi_gen-1.2.0/lib/ffi_gen.rb:745:in `generate'
Rename to ffi-gen ?
The usual convention for FFI helper libs is to be called ffi-foo and FFI::Foo. Would it be possible to rename ffi_gen to ffi-gen?
Does this require clang 3.0 or at least 3.0?
Newest clang is 3.5.0. Could you fix the readme if you meant "At least 3.0"?
by_ref should be used for returned structs
As seen here https://github.com/ffi/ffi/wiki/Structs#pointers-to-functions if a function returns a pointer to a struct, it should use SomeStruct.by_ref as the return type. Otherwise, ffi returns an FFI::Pointer.
Could not open library 'clang'
Not sure if this is an issue with ffi-gen or not but when I try and run ffi-gen I get the following error:
`block in ffi_lib': Could not open library 'clang': /usr/lib/clang: cannot read file data: Is a directory. (LoadError)
Could not open library 'libclang.so': libclang.so: cannot open shared object file: No such file or directory
Mind helping me out? I'm on Ubuntu and installed clang with apt-get but not sure what else i need to do to get it working.
Thanks!
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.