ffi-clang 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d482ffe964ca4f9817152f6fd3da834657851673
-  data.tar.gz: 405d56c4688d22790a36b7406ff8e0cffc924d1e
+  metadata.gz: f3fba953ec692d348f92786e6892450d93011103
+  data.tar.gz: 4e1b34caa60d2d0a577471d419170f998e1d5451
 SHA512:
-  metadata.gz: f64cf1ee129eddde74597bd12a69dfa93c0eacfd5fd1cea9795dc51fa0915738bca97d4f88e4375fff714bc26c1ed23a434a52ea645c44667e9b3956a86f7d7b
-  data.tar.gz: 8895a0b39bc1ba92c4e5a799b736ee574254c925eabbaf89d30079664a75df6dd1546a23f5e5b3f545cb6929e0239ed1b0d7b9661ece208570e1512b8d3ebdb4
+  metadata.gz: b90f7d9d97dca48869b045e76c3f1c57e6efc390a67c0a07cb95527a85c735f70f22cbf76e9a0745a3233fa9cc388c42efdb1ec0c042583c413335801f376132
+  data.tar.gz: ea69e1a70cb738ae85cbfd86a5de317724054926cdbc2e2bab50aa154497d53104ead7af30d7afb8e84c750f5e40952b2cde388b19f63621c48e2b975adb8239

data/.rspec

@@ -1 +1,5 @@
 --color
+--format documentation
+--backtrace
+--warnings
+--require spec_helper

data/.travis.yml

@@ -5,15 +5,26 @@ before_install:
   - export PATH=/usr/lib/llvm-${LLVM_VERSION}/bin:$PATH
 matrix:
   include:
-    # The default build:
-    - &libclang-36
-      addons: {apt: {sources: [ubuntu-toolchain-r-test, llvm-toolchain-precise-3.6], packages: [libclang-3.6-dev, clang-3.6]}}
+    - addons: {apt: {sources: [ubuntu-toolchain-r-test, llvm-toolchain-precise-3.6], packages: [libclang-3.6-dev, clang-3.6]}}
       env: LLVM_VERSION=3.6
-      rvm: "2.3.0"
-    # A second build with the same configuration but using ruby 2.2.4
-    - <<: *libclang-36
-      rvm: "2.2.4"
-    # Other builds on other versions of LLVM, all using ruby 2.3.0
+      rvm: "2.4.0"
     - addons: {apt: {sources: [ubuntu-toolchain-r-test, llvm-toolchain-precise-3.7], packages: [libclang-3.7-dev, clang-3.7]}}
       env: LLVM_VERSION=3.7
-      rvm: "2.3.0"
+      rvm: "2.4.0"
+    # The default build:
+    - &libclang-38
+      addons: {apt: {sources: [ubuntu-toolchain-r-test, llvm-toolchain-precise-3.8], packages: [libclang-3.8-dev, clang-3.8]}}
+      env: LLVM_VERSION=3.8
+      rvm: "2.4.0"
+    # A second build with the same configuration but using ruby 2.2.4
+    - <<: *libclang-38
+      rvm: "2.3.3"
+    - addons: {apt: {sources: [ubuntu-toolchain-r-test, llvm-toolchain-precise-3.9], packages: [libclang-3.9-dev, clang-3.9]}}
+      env: LLVM_VERSION=3.9
+      rvm: "2.4.0"
+    - addons: {apt: {sources: [ubuntu-toolchain-r-test, llvm-toolchain-precise-4.0], packages: [libclang-4.0-dev, clang-4.0]}}
+      env: LLVM_VERSION=4.0
+      rvm: "2.4.0"
+  allow_failures:
+  - env: LLVM_VERSION=4.0
+    rvm: "2.4.0"

data/Gemfile

@@ -1,4 +1,13 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in ffi-clang.gemspec
 gemspec
+
+group :development do
+	gem 'transpec'
+	gem 'pry'
+end
+
+group :test do
+	gem 'simplecov'
+	gem 'coveralls', require: false
+end

data/README.md

@@ -1,6 +1,6 @@
 # FFI::Clang
 
-A light-weight wrapper for Ruby exposing [libclang][1].
+A light-weight wrapper for Ruby exposing [libclang][1]. Works for libclang v3.4+.
 
 [![Build Status](https://secure.travis-ci.org/ioquatix/ffi-clang.svg)](http://travis-ci.org/ioquatix/ffi-clang)
 [![Code Climate](https://codeclimate.com/github/ioquatix/ffi-clang.svg)](https://codeclimate.com/github/ioquatix/ffi-clang)

data/Rakefile

@@ -1,12 +1,12 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-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
+RSpec::Core::RakeTask.new(:spec) do |task|
+	begin
+		require('simplecov/version')
+		task.rspec_opts = %w{--require simplecov} if ENV['COVERAGE']
+	rescue LoadError
+	end
 end
+
+task :default => :spec

data/examples/docs.cpp

@@ -0,0 +1,25 @@
+
+/** A test class which does nothing.
+
+	This is used by `main`.
+*/
+template<typename T>
+class Test {};
+
+/// This is a specialization for integers.
+template<>
+class Test<int> {
+public:
+	/// The number of times it has been incremented.
+	int count;
+	
+};
+
+/// This always fails.
+/// @param argc The number of items in `argv`. At least 1.
+/// @param argv The command line arguments, with argv[0] being the command used to execute this program.
+int main(int argc, char ** argv) {
+	Test<int> test;
+	
+	return 1;
+}

data/examples/docs.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'rainbow'
+require 'ffi/clang'
+
+index = FFI::Clang::Index.new
+
+# clang -Xclang -ast-dump -fsyntax-only ./examples/docs.cpp
+
+def title(declaration)
+	puts ["Symbol:", Rainbow(declaration.spelling).blue.bright, "Type:", Rainbow(declaration.type.spelling).green, declaration.kind.to_s].join(' ')
+end
+
+ARGV.each do |path|
+	translation_unit = index.parse_translation_unit(path)
+	
+	declarations = translation_unit.cursor.select(&:declaration?)
+	
+	declarations.each do |declaration|
+		title declaration
+		
+		if location = declaration.location
+			puts "Defined at #{location.file}:#{location.line}"
+		end
+		
+		if comment = declaration.comment
+			# puts Rainbow(comment.inspect).gray
+			puts Rainbow(comment.text)
+		end
+	end
+end

data/ffi-clang.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
 	spec.add_dependency "ffi"
 
 	spec.add_development_dependency "bundler", "~> 1.3"
-	spec.add_development_dependency "rspec", "~> 3.0.0"
+	spec.add_development_dependency "rspec", "~> 3.4.0"
 	spec.add_development_dependency "rake"
 end

data/lib/ffi/clang.rb

@@ -20,7 +20,7 @@
 # THE SOFTWARE.
 
 require 'ffi'
-require "rbconfig"
+require 'rbconfig'
 
 module FFI::Clang
 	class Error < StandardError
@@ -42,15 +42,18 @@ module FFI::Clang
 	end
 end
 
-require 'ffi/clang/utils'
-require 'ffi/clang/lib'
-require 'ffi/clang/index'
-require 'ffi/clang/translation_unit'
-require 'ffi/clang/diagnostic'
-require 'ffi/clang/cursor'
-require 'ffi/clang/source_location'
-require 'ffi/clang/source_range'
-require 'ffi/clang/unsaved_file'
-require 'ffi/clang/token'
-require 'ffi/clang/code_completion'
-require 'ffi/clang/compilation_database'
+# Load the shared object:
+require_relative 'clang/lib'
+
+# Wrappers around C functionality:
+require_relative 'clang/clang_version'
+require_relative 'clang/index'
+require_relative 'clang/translation_unit'
+require_relative 'clang/diagnostic'
+require_relative 'clang/cursor'
+require_relative 'clang/source_location'
+require_relative 'clang/source_range'
+require_relative 'clang/unsaved_file'
+require_relative 'clang/token'
+require_relative 'clang/code_completion'
+require_relative 'clang/compilation_database'

data/lib/ffi/clang/clang_version.rb

@@ -0,0 +1,29 @@
+# Copyright, 2016, 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_relative 'lib/clang_version'
+
+module FFI
+	module Clang
+		def self.clang_version_string
+			Lib.extract_string Lib.get_clang_version
+		end
+	end
+end

data/lib/ffi/clang/code_completion.rb

@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'ffi/clang/lib/code_completion'
+require_relative 'lib/code_completion'
 
 module FFI
 	module Clang

data/lib/ffi/clang/comment.rb

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright, 2013, by Carlos Martín Nieto <cmn@dwim.me>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,9 +18,9 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'ffi/clang/lib/cursor'
-require 'ffi/clang/lib/comment'
-require 'ffi/clang/source_location'
+require_relative 'lib/cursor'
+require_relative 'lib/comment'
+require_relative 'source_location'
 
 module FFI
 	module Clang
@@ -205,6 +204,7 @@ module FFI
 			def text
 				self.map(&:text).join("")
 			end
+
 			alias_method :comment, :text
 
 			def valid_index?
@@ -273,6 +273,10 @@ module FFI
 			def to_xml
 				Lib.extract_string Lib.full_comment_get_as_xml(@comment)
 			end
+			
+			def text
+				self.children.collect{|child| child.text.strip}.join("\n")
+			end
 		end
 	end
 end

data/lib/ffi/clang/compilation_database.rb

@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'ffi/clang/lib/compilation_database'
+require_relative 'lib/compilation_database'
 
 module FFI
 	module Clang

data/lib/ffi/clang/cursor.rb

@@ -20,11 +20,12 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'ffi/clang/lib/cursor'
-require 'ffi/clang/source_location'
-require 'ffi/clang/comment'
-require 'ffi/clang/type'
-require 'ffi/clang/lib/code_completion'
+require_relative 'lib/cursor'
+require_relative 'lib/code_completion'
+
+require_relative 'source_location'
+require_relative 'comment'
+require_relative 'type'
 
 module FFI
 	module Clang
@@ -238,18 +239,10 @@ module FFI
 				Lib.get_language @cursor
 			end
 
-			def translation_unit
-				@translation_unit
-			end
-
 			def num_args
 				Lib.get_num_args @cursor
 			end
 
-			def variadic?
-				Lib.is_variadic(@cursor) != 0
-			end
-
 			def visit_children(&block)
 				adapter = Proc.new do |cxcursor, parent_cursor, unused|
 					block.call Cursor.new(cxcursor, @translation_unit), Cursor.new(parent_cursor, @translation_unit)
@@ -348,12 +341,46 @@ module FFI
 				Lib.cursor_get_num_arguments(@cursor)
 			end
 
-			attr_reader :cursor
-
 			def ==(other)
 				Lib.are_equal(@cursor, other.cursor) != 0
 			end
 
+			def find_all(*kinds)
+				filter do |child, parent|
+					kinds.include?(child.kind)
+				end
+			end
+
+			def find_first(*kinds)
+				find_all(*kinds).first
+			end
+
+			def filter
+				return to_enum(:select) unless block_given?
+				
+				matching = []
+
+				self.visit_children do |child, parent|
+					if yield(child, parent)
+						matching << child
+					end
+
+					:recurse
+				end
+
+				return matching
+			end
+
+			def select
+				filter do |child, parent|
+					yield(child)
+				end
+			end
+
+			def to_a
+				filter.collect{|child, parent| child}
+			end
+
 			class PlatformAvailability < AutoPointer
 				def initialize(memory_pointer)
 					pointer = FFI::Pointer.new(memory_pointer)

data/lib/ffi/clang/diagnostic.rb

@@ -20,8 +20,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'ffi/clang/lib/diagnostic'
-require 'ffi/clang/source_range'
+require_relative 'lib/diagnostic'
+require_relative 'source_range'
 
 module FFI
 	module Clang
@@ -99,6 +99,10 @@ module FFI
 				Lib.get_diagnostic_category(self)
 			end
 
+			def inspect
+				"#{self.location}: #{self.format}"
+			end
+
 			private
 
 			def display_opts(opts)

data/lib/ffi/clang/file.rb

@@ -18,23 +18,20 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'ffi/clang/lib/file'
-require 'ffi/clang/utils'
+require_relative 'lib/file'
 
 module FFI
 	module Clang
 		class File < Pointer
 			attr_reader :translation_unit
 
-			def initialize(pointer, tu)
+			def initialize(pointer, translation_unit)
 				super pointer
-				@translation_unit = tu
+				@translation_unit = translation_unit
 
-				if FFI::Clang::Utils.satisfy_version?('3.3')
-					pointer = MemoryPointer.new(Lib::CXFileUniqueID)
-					Lib.get_file_unique_id(self, pointer)
-					@unique_id = Lib::CXFileUniqueID.new(pointer)
-				end
+				pointer = MemoryPointer.new(Lib::CXFileUniqueID)
+				Lib.get_file_unique_id(self, pointer)
+				@unique_id = Lib::CXFileUniqueID.new(pointer)
 			end
 
 			def to_s

data/lib/ffi/clang/index.rb

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'ffi/clang/lib/index'
+require_relative 'lib/index'
 
 module FFI
 	module Clang
@@ -45,9 +45,9 @@ module FFI
 			end
 
 			def create_translation_unit(ast_filename)
-				tu_pointer = Lib.create_translation_unit(self, ast_filename)
-				raise Error, "error parsing #{ast_filename.inspect}" if tu_pointer.null?
-				TranslationUnit.new tu_pointer, self
+				translation_unit_pointer = Lib.create_translation_unit(self, ast_filename)
+				raise Error, "error parsing #{ast_filename.inspect}" if translation_unit_pointer.null?
+				TranslationUnit.new translation_unit_pointer, self
 			end
 
 			private