remogatto-ffi-generator 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/
+generated/
+*.gem
+

data/History.txt

@@ -0,0 +1,10 @@
+== 0.1.0 / 2009-02-16
+
+* a bunch of minor fixes
+  * fix the gem build process
+  * new interface file for the wiiuse example
+
+== 0.0.1 / 2009-02-13
+
+* 1 major enhancement
+  * Birthday!

data/README.rdoc

@@ -0,0 +1,89 @@
+ffi-generator
+    by Andrea Fazzi
+    http://github.com/remogatto/ffi-generator/tree/master
+
+== DESCRIPTION:
+
+ffi-generator is a ruby-ffi wrapper code generator based on SWIG
+interfaces. 
+
+ffi-generator is able to traverse a XML parse tree file generated by
+SWIG and to produce a ruby file with ruby-ffi wrapper code inside.
+
+ffi-generator is shipped with a command line tool (ffi-gen) and a rake
+task that automates the code generation process.
+
+ffi-generator XML capabilities are provided by nokogiri.
+
+== FEATURES/PROBLEMS:
+
+* support for 
+  * all C native types
+  * #define constants
+  * typedefs
+  * struct, union, array and enum types 
+* naive indentation of the generated code
+
+== SYNOPSIS:
+
+From command line:
+
+  ffi-gen mylib.xml mylib.rb
+
+From a Rakefile:
+
+  require 'ffi-generator'
+  FFI::Generator::Task.new :input_fn => 'my_interface_dir/*.i' output_dir => 'my_output_dir'
+
+== REQUIREMENTS:
+
+* rake >= 0.8.3
+* nokogiri >= 1.1.1
+
+== INSTALL:
+
+  git clone git://github.com/remogatto/ffi-generator.git
+
+== EXAMPLES:
+
+See the examples in examples/ folder.
+
+libc.i is an interface file containing some excerpt of libc functions.
+
+wiiuse.i is a enough complex example of a C header file interface. It
+reproduces the content of wiiuse.h, the header file of the wiiuse
+library. wiiuse is a C library that handles the connection with
+Nintendo Wiimote devices. The interface file is almost a mere
+copy/paste from the original header file.
+
+== QUICK START:
+
+  git clone git://github.com/remogatto/ffi-generator.git
+  sudo apt-get install swig
+  sudo gem install nokogiri rake
+  cd ffi-generator/examples && rake ffi:generate
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Andrea Fazzi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,36 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require 'ffi-generator'
+
+task :default => 'spec:run'
+
+PROJ.name = 'ffi-generator'
+PROJ.authors = 'Andrea Fazzi'
+PROJ.email = 'andrea.fazzi@alcacoop.it'
+PROJ.url = 'http://github.com/remogatto/dokkit-core/tree/master'
+PROJ.version = FFI::Generator::VERSION
+PROJ.rubyforge.name = 'ffi-generator'
+
+depend_on 'rake'
+depend_on 'nokogiri'
+
+PROJ.readme_file = 'README.rdoc'
+
+PROJ.ruby_opts = []
+PROJ.spec.opts << '--color'
+
+# EOF

data/bin/ffi-gen

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib ffi-generator]))
+
+FFI::Generator::Application.run
+

data/examples/Rakefile

@@ -0,0 +1,4 @@
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib ffi-generator]))
+
+FFI::Generator::Task.new :input_fn => 'interfaces/*.i', :output_dir => 'generated'
+

data/examples/interfaces/libc.i

@@ -0,0 +1,26 @@
+%module libc
+
+%{
+require 'rubygems'
+require 'ffi'
+
+module LibC
+  extend FFI::Library
+%}
+
+typedef unsigned int size_t;
+
+struct timeval {
+  unsigned long tv_sec;
+  unsigned long tv_usec;
+};
+
+size_t strlen (const char *s);
+char * strcat (char *restrict to, const char *restrict from);
+int strcmp (const char *s1, const char *s2);
+
+int gettimeofday (struct timeval *tp, struct timezone *tzp);
+
+%{
+end
+%}