ffi-clang 0.3.0 → 0.5.0

data/spec/{clang → ffi/clang}/type_spec.rb

@@ -20,21 +20,19 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'spec_helper'
-
 describe Type do
 	let(:cursor) { Index.new.parse_translation_unit(fixture_path("a.c")).cursor }
 	let(:cursor_cxx) { Index.new.parse_translation_unit(fixture_path("test.cxx")).cursor }
 	let(:cursor_list) { Index.new.parse_translation_unit(fixture_path("list.c")).cursor }
 	let(:type) { find_first(cursor, :cursor_function).type }
 
-	it "can tell us about the main function", from_3_3: true do
-		type.variadic?.should equal(false)
+	it "can tell us about the main function" do
+		expect(type.variadic?).to equal(false)
 
-		type.num_arg_types.should equal(2)
-		type.arg_type(0).spelling.should eq("int")
-		type.arg_type(1).spelling.should eq("const char *")
-		type.result_type.spelling.should eq("int")
+		expect(type.num_arg_types).to equal(2)
+		expect(type.arg_type(0).spelling).to eq("int")
+		expect(type.arg_type(1).spelling).to eq("const char *")
+		expect(type.result_type.spelling).to eq("int")
 	end
 
   describe '#kind_spelling' do
@@ -42,7 +40,7 @@ describe Type do
       child.kind == :cursor_typedef_decl and child.spelling == 'const_int_ptr'}.type }
 
     it 'returns type kind name with string' do
-      kind_spelling_type.kind_spelling.should eq 'Typedef'
+      expect(kind_spelling_type.kind_spelling).to eq 'Typedef'
     end
   end
 
@@ -51,12 +49,7 @@ describe Type do
         child.kind == :cursor_typedef_decl and child.spelling == 'const_int_ptr'
       }.type.canonical }
 
-    it 'extracts typedef', upto_3_2: true do
-      expect(canonical_type).to be_kind_of(Type)
-      expect(canonical_type.kind).to be(:type_pointer)
-    end
-
-    it 'extracts typedef', from_3_3: true do
+    it 'extracts typedef' do
       expect(canonical_type).to be_kind_of(Type)
       expect(canonical_type.kind).to be(:type_pointer)
       expect(canonical_type.spelling).to eq('const int *')
@@ -68,12 +61,7 @@ describe Type do
         child.kind == :cursor_typedef_decl and child.spelling == 'const_int_ptr'
       }.type.canonical.pointee }
 
-    it 'gets pointee type of pointer, C++ reference', upto_3_2: true do
-      expect(pointee_type).to be_kind_of(Type)
-      expect(pointee_type.kind).to be(:type_int)
-    end
-
-    it 'gets pointee type of pointer, C++ reference', from_3_3: true do
+    it 'gets pointee type of pointer, C++ reference' do
       expect(pointee_type).to be_kind_of(Type)
       expect(pointee_type.kind).to be(:type_int)
       expect(pointee_type.spelling).to eq('const int')
@@ -90,11 +78,11 @@ describe Type do
       }.type.canonical.pointee }
 
     it 'checks type is const qualified' do
-      pointee_type.const_qualified?.should equal true
+      expect(pointee_type.const_qualified?).to equal true
     end
 
     it 'cannot check whether pointee type is const qualified' do
-      pointer_type.const_qualified?.should equal false
+      expect(pointer_type.const_qualified?).to equal false
     end
   end
 
@@ -160,7 +148,7 @@ describe Type do
     end
   end
 
-  describe '#alignof', from_3_3: true do
+  describe '#alignof' do
     let(:array_type) { find_matching(cursor_cxx) { |child, parent|
         child.kind == :cursor_variable and child.spelling == 'int_array'
       }.type }
@@ -171,7 +159,7 @@ describe Type do
     end
   end
 
-  describe '#sizeof', from_3_3: true do
+  describe '#sizeof' do
     let(:array_type) { find_matching(cursor_cxx) { |child, parent|
         child.kind == :cursor_variable and child.spelling == 'int_array'
       }.type }
@@ -182,7 +170,7 @@ describe Type do
     end
   end
 
-  describe '#offsetof', from_3_3: true do
+  describe '#offsetof' do
     let(:struct) { find_matching(cursor_list) { |child, parent|
         child.kind == :cursor_struct and child.spelling == 'List'
       }.type }
@@ -193,7 +181,7 @@ describe Type do
     end
   end
 
-  describe '#ref_qualifier', from_3_4: true do
+  describe '#ref_qualifier' do
     let(:lvalue) { find_matching(cursor_cxx) { |child, parent|
         child.kind == :cursor_cxx_method and child.spelling == 'func_lvalue_ref'
       }.type }
@@ -227,7 +215,7 @@ describe Type do
     end
   end
 
-  describe '#class_type', from_3_4: true do
+  describe '#class_type' do
     let(:member_pointer) { find_matching(cursor_cxx) { |child, parent|
         child.kind == :cursor_variable and child.spelling == 'member_pointer'
       }.type }
@@ -265,13 +253,9 @@ describe Type do
         child.kind == :cursor_function and child.spelling == 'f_variadic'
       }.type }
 
-    it 'returns the calling convention associated with the function type', from_3_4: true do
+    it 'returns the calling convention associated with the function type' do
       expect(function.calling_conv).to be(:calling_conv_c)
     end
-
-    it 'returns the calling convention associated with the function type', upto_3_3: true do
-      expect(function.calling_conv).to be(:calling_conv_default)
-    end
   end
 
   describe '#==' do

data/spec/ffi/clang/version_spec.rb

@@ -0,0 +1,28 @@
+# Copyright, 2014 by Masahiro Sano.
+# 
+# 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/version'
+
+describe FFI::Clang.clang_version_string do
+	it "returns a version string for showing to user" do
+		expect(subject).to be_kind_of(String)
+		expect(subject).to match(/Apple LLVM version \d+\.\d+\.\d+|clang version \d+\.\d+/)
+	end
+end

data/spec/spec_helper.rb

@@ -1,63 +1,37 @@
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require 'ffi/clang'
 
-include FFI::Clang
+require_relative '../lib/ffi/clang'
 
-TMP_DIR = File.expand_path("../tmp/", __FILE__)
+require 'pry'
 
-if ENV['LLVM_CONFIG']
-  llvm_bindir = `#{ENV['LLVM_CONFIG']} --bindir`.chomp
-  CLANG_COMPILER = File.expand_path('clang', llvm_bindir)
-  CLANGPP_COMPILER = File.expand_path('clang++', llvm_bindir)
-else
-  CLANG_COMPILER = 'clang'
-  CLANGPP_COMPILER = 'clang++'
-end
+include FFI::Clang
+
+TMP_DIR = File.expand_path("tmp", __dir__)
 
 module ClangSpecHelper
 	def fixture_path(path)
-		File.join File.expand_path("../fixtures", __FILE__), path
+		File.join File.expand_path("ffi/clang/fixtures", __dir__), path
 	end
 
 	def find_all(cursor, kind)
-		ret = []
-
-		cursor.visit_children do |cursor, parent|
-			if (cursor.kind == kind)
-				ret << cursor
-			end
-			:recurse
-		end
-
-		ret
+		cursor.find_all(kind)
 	end
 
 	def find_first(cursor, kind)
-		find_all(cursor, kind).first
+		cursor.find_first(kind)
 	end
 
 	def find_all_matching(cursor, &term)
-		ret = []
-
-		cursor.visit_children do |child, parent|
-			if term.call child, parent
-				ret << child
-			end
-
-			:recurse
-		end
-
-		ret
+		cursor.filter(&term)
 	end
 
 	def find_matching(cursor, &term)
-		find_all_matching(cursor, &term).first
+		cursor.filter(&term).first
 	end
 end
 
 RSpec.configure do |c|
 	c.include ClangSpecHelper
-	supported_versions = ['3.2', '3.3', '3.4', '3.5']
+	supported_versions = ['3.4', '3.5', '3.6', '3.7', '3.8', '3.9', '4.0']
 	current_version = ENV['LLVM_VERSION'] || supported_versions.last
 	supported_versions.reverse_each { |version|
 		break if version == current_version

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-clang
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jari Bakken
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,10 +81,13 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- examples/docs.cpp
+- examples/docs.rb
 - ext/rakefile.rb
 - ext/teapot.rb
 - ffi-clang.gemspec
 - lib/ffi/clang.rb
+- lib/ffi/clang/clang_version.rb
 - lib/ffi/clang/code_completion.rb
 - lib/ffi/clang/comment.rb
 - lib/ffi/clang/compilation_database.rb
@@ -93,6 +96,7 @@ files:
 - lib/ffi/clang/file.rb
 - lib/ffi/clang/index.rb
 - lib/ffi/clang/lib.rb
+- lib/ffi/clang/lib/clang_version.rb
 - lib/ffi/clang/lib/code_completion.rb
 - lib/ffi/clang/lib/comment.rb
 - lib/ffi/clang/lib/compilation_database.rb
@@ -107,39 +111,39 @@ files:
 - lib/ffi/clang/lib/token.rb
 - lib/ffi/clang/lib/translation_unit.rb
 - lib/ffi/clang/lib/type.rb
-- lib/ffi/clang/lib/utils.rb
 - lib/ffi/clang/source_location.rb
 - lib/ffi/clang/source_range.rb
 - lib/ffi/clang/token.rb
 - lib/ffi/clang/translation_unit.rb
 - lib/ffi/clang/type.rb
 - lib/ffi/clang/unsaved_file.rb
-- lib/ffi/clang/utils.rb
 - lib/ffi/clang/version.rb
-- spec/clang/code_completion_spec.rb
-- spec/clang/comment_spec.rb
-- spec/clang/compilation_database_spec.rb
-- spec/clang/cursor_spec.rb
-- spec/clang/diagnostic_spec.rb
-- spec/clang/file_spec.rb
-- spec/clang/index_spec.rb
-- spec/clang/source_location_spec.rb
-- spec/clang/source_range_spec.rb
-- spec/clang/token_spec.rb
-- spec/clang/translation_unit_spec.rb
-- spec/clang/type_spec.rb
-- spec/clang/utils_spec.rb
-- spec/fixtures/a.c
-- spec/fixtures/canonical.c
-- spec/fixtures/compile_commands.json
-- spec/fixtures/completion.cxx
-- spec/fixtures/docs.c
-- spec/fixtures/docs.cc
-- spec/fixtures/docs.h
-- spec/fixtures/list.c
-- spec/fixtures/location1.c
-- spec/fixtures/simple.c
-- spec/fixtures/test.cxx
+- spec/ffi/clang/code_completion_spec.rb
+- spec/ffi/clang/comment_spec.rb
+- spec/ffi/clang/compilation_database_spec.rb
+- spec/ffi/clang/cursor_spec.rb
+- spec/ffi/clang/diagnostic_spec.rb
+- spec/ffi/clang/file_spec.rb
+- spec/ffi/clang/fixtures/a.c
+- spec/ffi/clang/fixtures/canonical.c
+- spec/ffi/clang/fixtures/class.cpp
+- spec/ffi/clang/fixtures/compile_commands.json
+- spec/ffi/clang/fixtures/completion.cxx
+- spec/ffi/clang/fixtures/docs.c
+- spec/ffi/clang/fixtures/docs.cc
+- spec/ffi/clang/fixtures/docs.h
+- spec/ffi/clang/fixtures/list.c
+- spec/ffi/clang/fixtures/location1.c
+- spec/ffi/clang/fixtures/simple.ast
+- spec/ffi/clang/fixtures/simple.c
+- spec/ffi/clang/fixtures/test.cxx
+- spec/ffi/clang/index_spec.rb
+- spec/ffi/clang/source_location_spec.rb
+- spec/ffi/clang/source_range_spec.rb
+- spec/ffi/clang/token_spec.rb
+- spec/ffi/clang/translation_unit_spec.rb
+- spec/ffi/clang/type_spec.rb
+- spec/ffi/clang/version_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -161,33 +165,35 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Ruby FFI bindings for libclang C interface.
 test_files:
-- spec/clang/code_completion_spec.rb
-- spec/clang/comment_spec.rb
-- spec/clang/compilation_database_spec.rb
-- spec/clang/cursor_spec.rb
-- spec/clang/diagnostic_spec.rb
-- spec/clang/file_spec.rb
-- spec/clang/index_spec.rb
-- spec/clang/source_location_spec.rb
-- spec/clang/source_range_spec.rb
-- spec/clang/token_spec.rb
-- spec/clang/translation_unit_spec.rb
-- spec/clang/type_spec.rb
-- spec/clang/utils_spec.rb
-- spec/fixtures/a.c
-- spec/fixtures/canonical.c
-- spec/fixtures/compile_commands.json
-- spec/fixtures/completion.cxx
-- spec/fixtures/docs.c
-- spec/fixtures/docs.cc
-- spec/fixtures/docs.h
-- spec/fixtures/list.c
-- spec/fixtures/location1.c
-- spec/fixtures/simple.c
-- spec/fixtures/test.cxx
+- spec/ffi/clang/code_completion_spec.rb
+- spec/ffi/clang/comment_spec.rb
+- spec/ffi/clang/compilation_database_spec.rb
+- spec/ffi/clang/cursor_spec.rb
+- spec/ffi/clang/diagnostic_spec.rb
+- spec/ffi/clang/file_spec.rb
+- spec/ffi/clang/fixtures/a.c
+- spec/ffi/clang/fixtures/canonical.c
+- spec/ffi/clang/fixtures/class.cpp
+- spec/ffi/clang/fixtures/compile_commands.json
+- spec/ffi/clang/fixtures/completion.cxx
+- spec/ffi/clang/fixtures/docs.c
+- spec/ffi/clang/fixtures/docs.cc
+- spec/ffi/clang/fixtures/docs.h
+- spec/ffi/clang/fixtures/list.c
+- spec/ffi/clang/fixtures/location1.c
+- spec/ffi/clang/fixtures/simple.ast
+- spec/ffi/clang/fixtures/simple.c
+- spec/ffi/clang/fixtures/test.cxx
+- spec/ffi/clang/index_spec.rb
+- spec/ffi/clang/source_location_spec.rb
+- spec/ffi/clang/source_range_spec.rb
+- spec/ffi/clang/token_spec.rb
+- spec/ffi/clang/translation_unit_spec.rb
+- spec/ffi/clang/type_spec.rb
+- spec/ffi/clang/version_spec.rb
 - spec/spec_helper.rb

data/lib/ffi/clang/utils.rb

@@ -1,89 +0,0 @@
-# Copyright, 2014 by Masahiro Sano.
-# Copyright, 2014 by Samuel Williams.
-# 
-# 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/utils'
-require 'ffi/clang/lib/string'
-
-module FFI
-	module Clang
-		module Utils
-			@@clang_version = nil
-			
-			def self.clang_version_string
-				Lib.extract_string Lib.get_clang_version
-			end
-
-			def self.clang_version
-				unless @@clang_version
-					# Version string vary wildy:
-					# Ubuntu: "Ubuntu clang version 3.0-6ubuntu3 (tags/RELEASE_30/final) (based on LLVM 3.0)"
-					# Mac OS X: "Apple LLVM version 7.0.0 (clang-700.0.72)"
-					# Linux: "clang version 3.3"
-					if parts = clang_version_string.match(/^Apple LLVM version (\d+)\.(\d+).\d \(clang-.*\)$/)
-						@@clang_version = [3, 7] # Fake it.
-
-						puts "Using libclang: #{Lib::ffi_libraries[0].name}"
-						puts "Clang version detected: #{@@clang_version.inspect}"
-					elsif parts = clang_version_string.match(/(?:clang version|based on LLVM) (\d+)\.(\d+)(svn)?/)
-						major = parts[1].to_i
-						minor = parts[2].to_i
-						rc = parts[3]
-					
-						# Mac OS X currently reports support for 3.3svn, but this support is broken in some ways, so we revert it back to 3.2 which it supports completely.
-						if rc == 'svn'
-							minor -= 1
-						end
-					
-						@@clang_version = [major, minor]
-						
-						puts "Using libclang: #{Lib::ffi_libraries[0].name}"
-						puts "Clang version detected: #{@@clang_version.inspect}"
-					else
-						abort "Invalid/unsupported clang version string."
-					end
-				end
-				
-				return @@clang_version
-			end
-
-			def self.clang_version_symbol
-				"clang_#{clang_version.join('_')}".to_sym
-			end
-
-			def self.clang_major_version
-				clang_version[0]
-			end
-
-			def self.clang_minor_version
-				clang_version[1]
-			end
-
-			# Returns true if the current clang version is >= min version and optionally <= max_version
-			def self.satisfy_version?(min_version, max_version = nil)
-				min_version = Gem::Version.create(min_version)
-				max_version = Gem::Version.create(max_version) if max_version
-				current_version = Gem::Version.create(self.clang_version.join('.'))
-				
-				return (current_version >= min_version) && (!max_version || current_version <= max_version)
-			end
-		end
-	end
-end