mirror of https://github.com/ioquatix/ffi-clang
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.
57 lines
1.7 KiB
Markdown
57 lines
1.7 KiB
Markdown
# FFI::Clang
|
|
|
|
A light-weight wrapper for Ruby exposing [libclang](http://llvm.org/devmtg/2010-11/Gregor-libclang.pdf). Works for libclang v3.4+.
|
|
|
|
[](https://github.com/ioquatix/ffi-clang/actions?workflow=Test)
|
|
|
|
## 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
|
|
|
|
## 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](https://developercertificate.org/). 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](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
|