https://github.com/ioquatix/ffi-clang

Ruby FFI bindings for libclang 3.4+.
https://github.com/ioquatix/ffi-clang

cpp ffi libclang ruby

Last synced: 14 days ago
JSON representation

Ruby FFI bindings for libclang 3.4+.

• Host: GitHub
• URL: https://github.com/ioquatix/ffi-clang
• Owner: ioquatix
• License: mit
• Created: 2013-06-12T13:06:10.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2024-06-14T07:01:14.000Z (5 months ago)
• Last Synced: 2024-10-03T12:23:19.482Z (about 1 month ago)
• Topics: cpp, ffi, libclang, ruby
• Language: Ruby
• Homepage:
• Size: 440 KB
• Stars: 44
• Watchers: 8
• Forks: 36
• Open Issues: 9
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# FFI::Clang

A light-weight wrapper for Ruby exposing [libclang](http://llvm.org/devmtg/2010-11/Gregor-libclang.pdf). Works for libclang v3.4+.

[![Development Status](https://github.com/ioquatix/ffi-clang/workflows/Test/badge.svg)](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.