Ruby FFI bindings for libclang 3.4+.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
Samuel Williams 9a4c0c06e0
Reorganize `ffi/clang.rb`.
3 months ago
.github/workflows Add release notes & documentation tooling. 3 months ago
examples Modernize gem. (#58) 3 years ago
ext Modernize gem. (#58) 3 years ago
lib/ffi Reorganize `ffi/clang.rb`. 3 months ago
spec Restore `visit_children` method. Fixes #82. (#84) 6 months ago
.editorconfig Modernize gem. 1 year ago
.gitignore Modernize gem. 1 year ago
.mailmap Modernize gem. 1 year ago
.rspec Tidy up tests. 8 years ago
bake.rb Add release notes & documentation tooling. 3 months ago
ffi-clang.gemspec Modernize gem. 1 year ago
gems.rb Add release notes & documentation tooling. 3 months ago
license.md Modernize gem. 1 year ago
readme.md Add release notes & documentation tooling. 3 months ago
release.cert Modernize gem. (#58) 3 years ago
releases.md Add release notes & documentation tooling. 3 months ago

readme.md

FFI::Clang

A light-weight wrapper for Ruby exposing libclang. Works for libclang v3.4+.

Development Status

Installation

Add this line to your application's Gemfile:

gem 'ffi-clang'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ffi-clang

Usage

Traverse the AST in the given file:

index = Index.new
translation_unit = index.parse_translation_unit("list.c")
cursor = translation_unit.cursor
cursor.visit_children do |cursor, parent|
	puts "#{cursor.kind} #{cursor.spelling.inspect}"
	
	next :recurse 
end

Library Version

Due to issues figuring out which library to use, we require you to manually specify it. For example, to run the tests, with MacPorts llvm/clang 3.4, use the following:

LLVM_CONFIG=llvm-config-mp-3.4 rake

Releases

Contributing

We welcome contributions to this project.

  1. Fork it.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create new Pull Request.

Developer Certificate of Origin

This project uses the Developer Certificate of Origin. All contributors to this project must agree to this document to have their contributions accepted.

Contributor Covenant

This project is governed by the Contributor Covenant. All contributors and participants agree to abide by its terms.