ghazel-ffi_gen 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a6fd9f6a4be7633dcb73b531d9fbed87c571c9d
+  data.tar.gz: d83e65baa61764622e44c5a5605e139a1aa7a767
+SHA512:
+  metadata.gz: 7c7253dc0955031e6dddf511969f19459d8ba2cab12e78554c59761b01b4fab6fb5a16b6114f2ca4bb50939abdfa9518c146099c20bf26d193d0e3a48b4334f0
+  data.tar.gz: 79e0d47b1ccf464ac7b72eaa4996c22addd79e47f8f8270bfc9b507bdf1f0847264378a1cbb278272a25dbec7c425d96c3be085086805fae6ea4d59d6be274c3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Richard Musiol
+
+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/README.md

@@ -0,0 +1,83 @@
+# A generator for Ruby FFI bindings
+
+*Author:* Richard Musiol
+*Contributors:* Jeremy Voorhis (thanks for the initial idea)
+*License:* MIT (see LICENSE)
+
+
+## Features
+
+* Generation of FFI methods, structures, unions, enumerations and callbacks
+* Generation of YARD documentation comments
+* Tested with headers of the following libraries:
+  * Cairo
+  * CEF (Chromium Embedded Framework)
+  * Clang
+  * LibSSH2
+  * LLVM
+  * OpenGL
+  * SQLite3
+
+
+## Requirements
+
+* Ruby 1.9
+* Clang 3.5 or later ([Download](http://llvm.org/releases/download.html#3.5) the binaries or
+  build from source configured with ``--enable-shared``)
+
+*These requirements are only for running the generator. The generated files are Ruby 1.8 compatible and do not need Clang.*
+
+
+## Example
+
+Use the following interface in a script or Rake task:
+
+```ruby
+require "ffi_gen"
+
+FFIGen.generate(
+  module_name: "Clang",
+  ffi_lib:     "clang",
+  headers:     ["clang-c/Index.h"],
+  cflags:      `llvm-config --cflags`.split(" "),
+  prefixes:    ["clang_", "CX"],
+  output:      "clang-c/index.rb"
+)
+```
+
+Output: [clang-c/index.rb](https://github.com/neelance/ffi_gen/blob/master/test/output/clang-c/Index.rb)
+
+Other generated files can be found in the [test/output](https://github.com/neelance/ffi_gen/tree/master/test/output) directory.
+
+
+## Hints
+
+You may need to set additional include directories:
+
+```
+export CPATH=/usr/lib/gcc/x86_64-linux-gnu/4.6.1/include
+```
+
+Your GCC include paths can be seen with:
+
+```
+`gcc -print-prog-name=cc1` -v
+```
+
+
+## Projects using ffi_gen
+
+* https://github.com/jvoorhis/ruby-llvm
+
+
+## Roadmap
+
+* Support for more libraries:
+  * (Write me if you have a whish)
+* Automatic generation of object oriented wrappers
+* Polish YARD documentation comments some more
+
+
+## Feedback
+
+Please use GitHub's issue tracker for problems or suggestions. Pull requests are welcome, too.