ffi-clang 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWQwOTY2ZDA4ZWEzMjMwZDExZDY4ZDI3MDNmM2ZlYWJkYzFmZmI3Nw==
+  data.tar.gz: !binary |-
+    NzgyMmY3OTRjZGYxM2ZkNTQwNmZjYjU0YjE2ZDAwM2IwOThmMDIxZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MTI0NGZlMzYyMGRmYTdhOGQwZDlmYzQzNTA0M2U4NmZlMmZjYjQ2ZDEzOGRk
+    ODE3NjIyMzliOGQyOTBhOWZiOGFhMmVkZjA5MDUwNmYxZjUxMWI3NDJhMTky
+    ZTc0ODc2OTJmNjQ4NmQxMDMwYjdlMjEzM2M0MTFjYjRjNDIxM2E=
+  data.tar.gz: !binary |-
+    NDI0MDJhYThkZGRiNGQ3MjMwYWYyNjU4NzI2NmY0NzMzOTIwZGI1OGQyY2Rj
+    YzM2MjEzMTJmMmRjMzkwYmJlZjIxNzZhZDI2OGI2YTY0ZjdlYjkyODkwNjQ0
+    OWQwNDE2ZGE4ZDE4YmRjOTZjN2YzZWQ2NDdkZWM1ZjhiZDIwNmQ=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "2.0"
+install:
+# libclang-3.2-dev
+    - sudo add-apt-repository --yes ppa:h-rayflood/llvm
+    - sudo apt-get -qq update
+    - sudo apt-get -qq install libclang-3.2-dev
+    - bundle install

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ffi-clang.gemspec
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+# FFI::Clang
+
+Ruby FFI bindings for libclang. WIP.
+
+http://llvm.org/devmtg/2010-11/Gregor-libclang.pdf
+
+## 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
+
+TODO: Write usage instructions here
+
+## Contributing
+
+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
+
+## License
+
+Copyright, 2010-2012 by Jari Bakken.
+Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+
+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,12 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+ 
+desc 'Default: run specs.'
+task :default => :spec
+ 
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+	t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+	# Put spec opts in a file named .rspec in root
+end

data/ffi-clang.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ffi/clang/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "ffi-clang"
+	spec.version       = FFI::Clang::VERSION
+	spec.authors       = ["Jari Bakken", "Samuel Williams"]
+	spec.email         = ["Jari Bakken", "samuel.williams@oriontransfer.co.nz"]
+	spec.description   = %q{Ruby FFI bindings for libclang C interface.}
+	spec.summary       = %q{Ruby FFI bindings for libclang C interface.}
+	spec.homepage      = ""
+	spec.license       = "MIT"
+
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_dependency "ffi"
+
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rake"
+	spec.add_development_dependency "rspec"
+end

data/lib/ffi/clang.rb

@@ -0,0 +1,51 @@
+# Copyright, 2010-2012 by Jari Bakken.
+# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'ffi'
+require "rbconfig"
+
+module FFI::Clang
+	class Error < StandardError
+	end
+
+	def self.platform
+		os = RbConfig::CONFIG["host_os"]
+
+		case os
+		when /darwin/
+			:osx
+		when /linux/
+			:linux
+		when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+			:windows
+		else
+			os
+		end
+	end
+end
+
+require 'ffi/clang/lib'
+require 'ffi/clang/index'
+require 'ffi/clang/translation_unit'
+require 'ffi/clang/diagnostic'
+#require 'ffi/clang/source_location'
+#require 'ffi/clang/source_range'
+

data/lib/ffi/clang/diagnostic.rb

@@ -0,0 +1,86 @@
+# Copyright, 2010-2012 by Jari Bakken.
+# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'ffi/clang/lib/diagnostic'
+
+module FFI
+	module Clang
+		class SourceRange
+			def initialize(range_struct)
+			end
+		end
+		
+		class Diagnostic < AutoPointer
+			def initialize(translation_unit, pointer)
+				super pointer
+				
+				@translation_unit = translation_unit
+			end
+			
+			def self.release(pointer)
+				Lib.dispose_diagnostic(pointer)
+			end
+
+			def format(opts = {})
+				cxstring = Lib.format_diagnostic(self, display_opts(opts))
+				Lib.extract_string cxstring
+			end
+
+			def severity
+				Lib.get_diagnostic_severity self
+			end
+
+			def spelling
+				Lib.get_string Lib.get_diagnostic_spelling(self)
+			end
+
+			def fixits
+				raise NotImplementedError
+				# unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diag);
+				# – CXString clang_getDiagnosticFixIt(CXDiagnostic Diag,
+				#                                     unsigned FixIt,
+				#                                     CXSourceRange *ReplacementRange);
+
+			end
+
+			def ranges
+				n = Lib.get_diagnostic_num_ranges(self)
+				
+				n.times.map {|i| SourceRange.new Lib.get_diagnostic_range(self, i)}
+			end
+
+			private
+
+			def range_count
+				
+			end
+
+			def display_opts(opts)
+				if opts.empty?
+					Lib.default_diagnostic_display_options
+				else
+					Lib.bitmask_from Lib::DiagnosticDisplayOptions, opts
+				end
+			end
+
+		end
+	end
+end

data/lib/ffi/clang/index.rb

@@ -0,0 +1,64 @@
+# Copyright, 2010-2012 by Jari Bakken.
+# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'ffi/clang/lib/index'
+
+module FFI
+	module Clang
+		class Index < AutoPointer
+			def initialize(exclude_declarations = true, display_diagnostics = false)
+				super Lib.create_index(exclude_declarations ? 1 : 0, display_diagnostics ? 1 : 0)
+			end
+
+			def self.release(pointer)
+				Lib.dispose_index_debug(pointer)
+			end
+
+			def parse_translation_unit(source_file, command_line_args = nil, opts = {})
+				command_line_args = Array(command_line_args)
+
+				translation_unit_pointer = Lib.parse_translation_unit(self, source_file, args_pointer_from(command_line_args), command_line_args.size, nil, 0, options_bitmask_from(opts))
+
+				raise Error, "error parsing #{source_file.inspect}" unless translation_unit_pointer
+
+				TranslationUnit.new translation_unit_pointer
+			end
+
+			private
+
+			def args_pointer_from(command_line_args)
+				args_pointer = MemoryPointer.new(:pointer)
+
+				strings = command_line_args.map do |arg|
+					MemoryPointer.from_string(arg.to_s)
+				end
+
+				args_pointer.put_array_of_pointer(strings) unless strings.empty?
+				args_pointer
+			end
+
+			def options_bitmask_from(opts)
+				Lib.bitmask_from Lib::TranslationUnitFlags, opts
+			end
+
+		end
+	end
+end

data/lib/ffi/clang/lib.rb

@@ -0,0 +1,55 @@
+# Copyright, 2010-2012 by Jari Bakken.
+# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module FFI
+	module Clang
+		module Lib
+			extend FFI::Library
+
+			libs = ["clang"]
+
+			if Clang.platform == :linux
+				libs += [
+					"/usr/lib/llvm-3.2/lib/libclang.so",
+					"/usr/lib64/llvm-3.2/lib/libclang.so"
+				]
+			end
+
+			ffi_lib libs
+			
+			def self.bitmask_from(enum, opts)
+				bitmask = 0
+
+				opts.each do |key, val|
+					next unless val
+
+					if int = enum[key]
+						bitmask |= int
+					else
+						raise Error, "unknown option: #{key.inspect}, expected one of #{enum.symbols}"
+					end
+				end
+
+				bitmask
+			end
+		end
+	end
+end

data/lib/ffi/clang/lib/diagnostic.rb

@@ -0,0 +1,75 @@
+# Copyright, 2010-2012 by Jari Bakken.
+# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'ffi/clang/lib/translation_unit'
+require 'ffi/clang/lib/string'
+
+module FFI
+	module Clang
+		module Lib
+			class CXSourceLocation < FFI::Struct
+				layout(
+					:ptr_data1, :pointer,
+					:ptr_data2, :pointer,
+					:int_data, :uint
+				)
+			end
+			
+			class CXSourceRange < FFI::Struct
+				layout(
+					:ptr_data1, :pointer,
+					:ptr_data2, :pointer,
+					:begin_int_data, :uint,
+					:end_int_data, :uint
+				)
+			end
+			
+			typedef :pointer, :CXDiagnostic
+
+			# Source code diagnostics:
+			attach_function :get_num_diagnostics, :clang_getNumDiagnostics, [:CXTranslationUnit], :uint
+			attach_function :get_diagnostic, :clang_getDiagnostic, [:CXTranslationUnit,  :uint], :CXDiagnostic
+			attach_function :dispose_diagnostic, :clang_disposeDiagnostic, [:CXDiagnostic], :void
+			
+			attach_function :get_diagnostic_location, :clang_getDiagnosticLocation, [:CXDiagnostic], CXSourceLocation.by_value
+			
+			# Diagnostic details and string representations:
+			DiagnosticDisplayOptions = enum [:source_location, 0x01, :column, 0x02, :source_ranges, 0x04]
+			attach_function :default_diagnostic_display_options, :clang_defaultDiagnosticDisplayOptions, [], :uint
+			attach_function :format_diagnostic, :clang_formatDiagnostic, [:CXDiagnostic, :uint], CXString.by_value
+			
+			attach_function :get_diagnostic_spelling, :clang_getDiagnosticSpelling, [:CXDiagnostic], CXString.by_value
+			
+			enum :diagnostic_severity, [:ignored, :note, :warning, :error, :fatal]
+			attach_function :get_diagnostic_severity, :clang_getDiagnosticSeverity, [:CXDiagnostic], :diagnostic_severity
+			
+			# Diagnostic source ranges:
+			attach_function :get_diagnostic_num_ranges, :clang_getDiagnosticNumRanges, [:CXDiagnostic], :uint
+			attach_function :get_diagnostic_range, :clang_getDiagnosticRange, [:CXDiagnostic, :uint], CXSourceRange.by_value
+			
+			# Range to source code location conversion:
+			attach_function :get_range_start, :clang_getRangeStart, [CXSourceRange.by_value], CXSourceLocation.by_value
+			attach_function :get_range_end, :clang_getRangeEnd, [CXSourceRange.by_value], CXSourceLocation.by_value
+			
+			attach_function :equal_locations, :clang_equalLocations, [CXSourceLocation.by_value, CXSourceLocation.by_value], :uint
+		end
+	end
+end

data/lib/ffi/clang/lib/file.rb

@@ -0,0 +1,37 @@
+# Copyright, 2010-2012 by Jari Bakken.
+# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'ffi/clang/lib/string'
+require 'ffi/clang/lib/translation_unit'
+
+module FFI
+	module Clang
+		module Lib
+			typedef :pointer, :CXFile
+			
+			# Retrieve a file handle within the given translation unit.
+			attach_function :get_file, :clang_getFile, [:CXTranslationUnit, :string], :CXFile
+			
+			# Retrieve the complete file and path name of the given file.
+			attach_function :get_file_name, :clang_getFileName, [:CXFile], CXString.by_value
+		end
+	end
+end

data/lib/ffi/clang/lib/index.rb

@@ -0,0 +1,34 @@
+# Copyright, 2010-2012 by Jari Bakken.
+# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'ffi/clang/lib'
+
+module FFI
+	module Clang
+		module Lib
+			typedef :pointer, :CXIndex
+			
+			# Source code index:
+			attach_function :create_index, :clang_createIndex, [:int, :int], :CXIndex
+			attach_function :dispose_index, :clang_disposeIndex, [:CXIndex], :void
+		end
+	end
+end

data/lib/ffi/clang/lib/string.rb

@@ -0,0 +1,45 @@
+# Copyright, 2010-2012 by Jari Bakken.
+# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'ffi/clang/lib'
+
+module FFI
+	module Clang
+		module Lib
+			class CXString < FFI::Struct
+				layout(
+					:data, :pointer,
+					:private_flags, :uint
+				)
+			end
+
+			attach_function :get_string, :clang_getCString, [CXString.by_value], :string
+			attach_function :dispose_string, :clang_disposeString, [CXString.by_value], :void
+
+			def self.extract_string(cxstring)
+				result = get_string(cxstring)
+				dispose_string cxstring
+
+				return result
+			end
+		end
+	end
+end

data/lib/ffi/clang/lib/translation_unit.rb

@@ -0,0 +1,36 @@
+# Copyright, 2010-2012 by Jari Bakken.
+# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'ffi/clang/lib/index'
+
+module FFI
+	module Clang
+		module Lib
+			typedef :pointer, :CXTranslationUnit
+
+			TranslationUnitFlags = enum [:none, :detailed_preprocessing_record, :incomplete, :precompiled_preamble, :cache_completion_results]
+
+			# Source code translation units:
+			attach_function :parse_translation_unit, :clang_parseTranslationUnit, [:CXIndex, :string, :pointer, :int, :pointer, :uint, :uint], :CXTranslationUnit
+			attach_function :dispose_translation_unit, :clang_disposeTranslationUnit, [:CXTranslationUnit], :void
+		end
+	end
+end

data/lib/ffi/clang/translation_unit.rb

@@ -0,0 +1,45 @@
+# Copyright, 2010-2012 by Jari Bakken.
+# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'ffi/clang/lib/translation_unit'
+
+module FFI
+	module Clang
+		class TranslationUnit < AutoPointer
+			def initialize(pointer)
+				super pointer
+			end
+
+			def self.release(pointer)
+				Lib.dispose_translation_unit(pointer)
+			end
+
+			def diagnostics
+				n = Lib.get_num_diagnostics(self)
+			
+				n.times.map do |i|
+					Diagnostic.new(self, Lib.get_diagnostic(self, i))
+				end
+			end
+
+		end
+	end
+end

data/lib/ffi/clang/version.rb

@@ -0,0 +1,26 @@
+# Copyright, 2010-2012 by Jari Bakken.
+# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module FFI
+	module Clang
+		VERSION = "0.1.0"
+	end
+end

data/spec/clang/diagnostic_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Diagnostic do
+	let(:diagnostics) { Index.new.parse_translation_unit(fixture_path("list.c")).diagnostics }
+	let(:diagnostic) { diagnostics.first }
+
+	it "returns a string representation of the diagnostic" do
+		str = diagnostic.format
+		str.should be_kind_of(String)
+		str.should =~ /does not match previous/
+	end
+    
+	it "returns a string representation according to the given opts" do
+		diagnostic.format(:source_location => true).should include("list.c:5")
+	end
+    
+	it "returns the text of the diagnostic" do
+		diagnostic.spelling.should be_kind_of(String)
+	end
+    
+	it "returns the severity of the diagnostic" do
+		diagnostic.severity.should == :error
+	end
+    
+	it "returns the ranges of the diagnostic" do
+		rs = diagnostics[1].ranges
+		rs.should be_kind_of(Array)
+		rs.should_not be_empty
+		rs.first.should be_kind_of(SourceRange)
+	end
+end

data/spec/clang/index_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Index do
+	let(:index) { Index.new }
+
+	it "can parse a source file" do
+		tu = index.parse_translation_unit fixture_path("a.c")
+		tu.should be_kind_of(TranslationUnit)
+	end
+end

data/spec/clang/translation_unit_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe TranslationUnit do
+	let(:tu) { Index.new.parse_translation_unit fixture_path("a.c")  }
+
+	it "returns a list of diagnostics" do
+		diags = tu.diagnostics
+		diags.should be_kind_of(Array)
+		diags.should_not be_empty
+	end
+end

data/spec/fixtures/a.c

@@ -0,0 +1,4 @@
+int main(int argc, char const *argv)
+{
+  return 0;
+}

data/spec/fixtures/list.c

@@ -0,0 +1,10 @@
+struct List {
+  int Data;
+  struct List *Next;
+};
+int sum(union List *L) { return 1; };
+
+main(int argc, char const *argv)
+{
+    return 0;
+}

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'ffi/clang'
+
+include FFI::Clang
+
+module ClangSpecHelper
+	def fixture_path(path)
+		File.join File.expand_path("../fixtures", __FILE__), path
+	end
+end
+
+RSpec.configure do |c|
+	c.include ClangSpecHelper
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: ffi-clang
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jari Bakken
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby FFI bindings for libclang C interface.
+email:
+- Jari Bakken
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- ffi-clang.gemspec
+- lib/ffi/clang.rb
+- lib/ffi/clang/diagnostic.rb
+- lib/ffi/clang/index.rb
+- lib/ffi/clang/lib.rb
+- lib/ffi/clang/lib/diagnostic.rb
+- lib/ffi/clang/lib/file.rb
+- lib/ffi/clang/lib/index.rb
+- lib/ffi/clang/lib/string.rb
+- lib/ffi/clang/lib/translation_unit.rb
+- lib/ffi/clang/translation_unit.rb
+- lib/ffi/clang/version.rb
+- spec/clang/diagnostic_spec.rb
+- spec/clang/index_spec.rb
+- spec/clang/translation_unit_spec.rb
+- spec/fixtures/a.c
+- spec/fixtures/list.c
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Ruby FFI bindings for libclang C interface.
+test_files:
+- spec/clang/diagnostic_spec.rb
+- spec/clang/index_spec.rb
+- spec/clang/translation_unit_spec.rb
+- spec/fixtures/a.c
+- spec/fixtures/list.c
+- spec/spec_helper.rb