ffi-clang 0.1.3 → 0.2.0

data/lib/ffi/clang/lib/type.rb

@@ -1,3 +1,23 @@
+# 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
@@ -5,8 +25,51 @@ module FFI
 				:type_invalid, 0,
 				:type_unexposed, 1,
 				:type_void, 2,
+				:type_bool, 3,
+				:type_char_u, 4,
+				:type_uchar, 5,
+				:type_char16, 6,
+				:type_char32, 7,
+				:type_ushort, 8,
+				:type_uint, 9,
+				:type_ulong, 10,
+				:type_ulonglong, 11,
+				:type_uint128, 12,
+				:type_char_s, 13,
+				:type_schar, 14,
+				:type_wchar, 15,
+				:type_short, 16,
+				:type_int, 17,
+				:type_long, 18,
+				:type_longlong, 19,
+				:type_int128, 20,
+				:type_float, 21,
+				:type_double, 22,
+				:type_longdouble, 23,
+				:type_nullptr, 24,
+				:type_overload, 25,
+				:type_dependent, 26,
+				:type_obj_c_id, 27,
+				:type_obj_c_class, 28,
+				:type_obj_c_sel, 29,
+				:type_complex, 100,
 				:type_pointer, 101,
-				:type_function_proto, 111
+				:type_block_pointer, 102,
+				:type_lvalue_ref, 103,
+				:type_rvalue_ref, 104,
+				:type_record, 105,
+				:type_enum, 106,
+				:type_typedef, 107,
+				:type_obj_c_interface, 108,
+				:type_obj_c_object_pointer, 109,
+				:type_function_no_proto, 110,
+				:type_function_proto, 111,
+				:type_constant_array, 112,
+				:type_vector, 113,
+				:type_incomplete_array, 114,
+				:type_variable_array, 115,
+				:type_dependent_sized_array, 116,
+				:type_member_pointer, 117,
 			]
 
 			class CXType < FFI::Struct
@@ -16,13 +79,18 @@ module FFI
 				)
 			end
 
-			attach_function :get_type_spelling, :clang_getTypeSpelling, [CXType.by_value], CXString.by_value
+			attach_function :get_pointee_type, :clang_getPointeeType, [CXType.by_value], CXType.by_value
+			attach_function :get_type_kind_spelling, :clang_getTypeKindSpelling, [:kind], CXString.by_value
+			if FFI::Clang::Utils.satisfy_version?('3.3')
+				attach_function :get_type_spelling, :clang_getTypeSpelling, [CXType.by_value], CXString.by_value
+			end
 			attach_function :is_function_type_variadic, :clang_isFunctionTypeVariadic, [CXType.by_value], :uint
 			attach_function :is_pod_type, :clang_isPODType, [CXType.by_value], :uint
 			attach_function :get_num_arg_types, :clang_getNumArgTypes, [CXType.by_value], :int
 			attach_function :get_arg_type, :clang_getArgType, [CXType.by_value, :uint], CXType.by_value
 			attach_function :get_result_type, :clang_getResultType, [CXType.by_value], CXType.by_value
-
+			attach_function :get_canonical_type, :clang_getCanonicalType, [CXType.by_value], CXType.by_value
+			attach_function :is_const_qualified_type, :clang_isConstQualifiedType, [CXType.by_value], :uint
 		end
 	end
 end

data/lib/ffi/clang/lib/utils.rb

@@ -0,0 +1,29 @@
+# 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/lib/string'
+
+module FFI
+	module Clang
+		module Lib
+			attach_function :get_clang_version, :clang_getClangVersion, [], CXString.by_value
+		end
+	end
+end

data/lib/ffi/clang/source_location.rb

@@ -35,8 +35,8 @@ module FFI
 
 				Lib::get_expansion_location(@location, cxfile, line, column, offset)
 
-				@file   = Lib.extract_string Lib.get_file_name(cxfile.read_pointer)
-				@line   = line.get_uint(0)
+				@file = Lib.extract_string Lib.get_file_name(cxfile.read_pointer)
+				@line = line.get_uint(0)
 				@column = column.get_uint(0)
 				@offset = offset.get_uint(0)
 			end

data/lib/ffi/clang/translation_unit.rb

@@ -25,8 +25,9 @@ require 'ffi/clang/cursor'
 module FFI
 	module Clang
 		class TranslationUnit < AutoPointer
-			def initialize(pointer)
+			def initialize(pointer, index)
 				super pointer
+				@index = index
 			end
 
 			def self.release(pointer)
@@ -42,7 +43,7 @@ module FFI
 			end
 
 			def cursor
-				Cursor.new(Lib.get_translation_unit_cursor(self))
+				Cursor.new(Lib.get_translation_unit_cursor(self), self)
 			end
 		end
 	end

data/lib/ffi/clang/type.rb

@@ -1,14 +1,39 @@
+# 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
 		class Type
-			def initialize(type)
+			def initialize(type, translation_unit)
 				@type = type
+				@translation_unit = translation_unit
 			end
 
 			def kind
 				@type[:kind]
 			end
 
+			def kind_spelling
+				Lib.extract_string Lib.get_type_kind_spelling @type[:kind]
+			end
+
 			def spelling
 				Lib.extract_string Lib.get_type_spelling(@type)
 			end
@@ -25,12 +50,24 @@ module FFI
 				Lib.get_num_arg_types(@type)
 			end
 
+			def pointee
+				Type.new Lib.get_pointee_type(@type), @translation_unit
+			end
+
+			def canonical
+				Type.new Lib.get_canonical_type(@type), @translation_unit
+			end
+
+			def const_qualified?
+				Lib.is_const_qualified_type(@type) != 0
+			end
+
 			def arg_type(i)
-				Type.new Lib.get_arg_type(@type, i)
+				Type.new Lib.get_arg_type(@type, i), @translation_unit
 			end
 
 			def result_type
-				Type.new Lib.get_result_type(@type)
+				Type.new Lib.get_result_type(@type), @translation_unit
 			end
 		end
 	end

data/lib/ffi/clang/utils.rb

@@ -0,0 +1,58 @@
+# 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/lib/utils'
+require 'ffi/clang/lib/string'
+
+module FFI
+	module Clang
+		class Utils
+			def self.clang_version_string
+				Lib.extract_string Lib.get_clang_version
+			end
+
+			def self.clang_version
+				version = clang_version_string
+				version.match(/clang version (\d+\.\d+)/).values_at(1).first
+			end
+
+			def self.clang_version_symbol
+				version = "clang_" + clang_version.tr('.', '_')
+				version.intern
+			end
+
+			def self.clang_major_version
+				version = clang_version_string
+				version.match(/clang version (\d+)\./).values_at(1).first.to_i
+			end
+
+			def self.clang_minor_version
+				version = clang_version_string
+				version.match(/clang version \d+\.(\d+)/).values_at(1).first.to_i
+			end
+
+			def self.satisfy_version?(min_version, max_version = nil)
+				Gem::Version.create(self.clang_version) >= Gem::Version.create(min_version) and
+					(max_version.nil? or
+					Gem::Version.create(self.clang_version) <= Gem::Version.create(max_version))
+			end
+		end
+	end
+end

data/lib/ffi/clang/version.rb

@@ -21,6 +21,6 @@
 
 module FFI
 	module Clang
-		VERSION = "0.1.3"
+		VERSION = "0.2.0"
 	end
 end

data/spec/clang/comment_spec.rb

@@ -63,22 +63,35 @@ describe Comment do
 	end
 
 	it "understands params" do
-		param = comment.child(3)
-		param.should be_kind_of(ParamCommandComment)
-
-		param.valid_index?.should == true
-		param.index.should equal(0)
-		param.name.should eq("input")
-		arg = " some input\n "
-		param.child.text.should eq(arg)
-		param.comment.should eq(arg)
-	end
+		[['input', " some input\n "], ['flags', " some flags\n "]].each_with_index do |v, child_idx|
+			param = comment.child(3 + child_idx)
+			param.should be_kind_of(ParamCommandComment)
 
-	it "understands blocks" do
-		block = comment.child(5)
-		block.should be_kind_of(BlockCommandComment)
-		block.name.should eq("return")
-		block.comment.should eq(" a random value\n ")
+			param.valid_index?.should == true
+			param.index.should equal(child_idx)
+			param.name.should eq(v[0])
+			param.child.text.should eq v[1]
+			param.comment.should eq v[1]
+		end
 	end
 
+	describe "understands blocks" do
+		let (:block) { comment.child(5) }
+
+		it 'is BlockCommandComment' do
+			expect(block).to be_kind_of(BlockCommandComment)
+		end
+
+		it 'has name' do
+			expect(block.name).to eq("return")
+		end
+
+		it 'has comment', from_3_4: true do
+			expect(block.comment).to eq(" a random value")
+		end
+
+		it 'has comment', upto_3_3: true do
+			expect(block.comment).to eq(" a random value\n ")
+		end
+	end
 end

data/spec/clang/cursor_spec.rb

@@ -11,7 +11,7 @@
 # 
 # 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
@@ -24,6 +24,8 @@ require 'spec_helper'
 
 describe Cursor do
 	let(:cursor) { Index.new.parse_translation_unit(fixture_path("list.c")).cursor }
+	let(:cursor_cxx) { Index.new.parse_translation_unit(fixture_path("test.cxx")).cursor }
+	let(:cursor_canon) { Index.new.parse_translation_unit(fixture_path("canonical.c")).cursor }
 
 	it "can be obtained from a translation unit" do
 		cursor.should be_kind_of(Cursor)
@@ -37,15 +39,26 @@ describe Cursor do
 		location.should be_kind_of(SourceLocation)
 	end
 
-	it "has an extent which is a SourceRange" do
-		extent = cursor.extent
-		extent.should be_kind_of(SourceRange)
+	describe '#extent' do
+		let(:extent) { cursor.extent }
+		it "has an extent which is a SourceRange" do
+			expect(extent).to be_kind_of(SourceRange)
+		end
+
+		it 'has filename and posion at start point' do
+			expect(extent.start.file).to eq(fixture_path("list.c"))
+			expect(extent.start.line).to equal(1)
+		end
 
-		extent.start.file.should eq(fixture_path("list.c"))
-		extent.start.line.should equal(1)
+		it 'has filename and posion at end point', from_3_4: true do
+			expect(extent.end.file).to eq(fixture_path("list.c"))
+			expect(extent.end.line).to equal(11)
+		end
 
-		extent.end.file.should eq(fixture_path("list.c"))
-		extent.end.line.should equal(10)
+		it 'has filename and posion at end point', upto_3_3: true do
+			expect(extent.end.file).to eq(fixture_path("list.c"))
+			expect(extent.end.line).to equal(10)
+		end
 	end
 
 	it "returns the path of the translation unit for the translation unit cursor" do
@@ -128,5 +141,246 @@ describe Cursor do
 		end
 
 	end
-	
+
+	describe '#virtual_base?' do
+		let(:virtual_base_cursor) { find_matching(cursor_cxx) { |child, parent|
+				child.kind == :cursor_cxx_base_specifier and parent.spelling == 'B' } }
+
+		it 'checks cursor is virtual base' do
+			virtual_base_cursor.virtual_base?.should equal true
+		end
+	end
+
+	describe '#virtual?' do
+		let(:virtual_cursor) { find_matching(cursor_cxx) { |child, parent|
+				child.kind == :cursor_cxx_method and child.spelling == 'func_a' } }
+
+		it 'checks member function is virtual' do
+			virtual_cursor.virtual?.should equal true
+		end
+	end
+
+	describe '#pure_virtual?', from_3_4: true do
+		let(:pure_virtual_cursor) { find_matching(cursor_cxx) { |child, parent|
+				child.kind == :cursor_cxx_method and
+				child.spelling == 'func_a' and parent.spelling == 'A' } }
+
+		it 'checks member function is purely virtual' do
+			pure_virtual_cursor.pure_virtual?.should equal true
+		end
+	end
+
+	describe '#static?' do
+		let(:static_method_cursor) { find_matching(cursor_cxx) { |child, parent|
+			child.kind == :cursor_cxx_method and child.spelling == 'func_b' } }
+
+		it 'checks cursor is static member function' do
+			static_method_cursor.static?.should equal true
+		end
+	end
+
+	describe '#enum_value' do
+		let(:enum_value_cursor) { find_matching(cursor_cxx) { |child, parent|
+			child.kind == :cursor_enum_constant_decl and child.spelling == 'EnumC' } }
+
+		it 'returns enum value' do
+			enum_value_cursor.enum_value.should equal 100
+		end
+	end
+
+	describe '#dynamic_call?' do
+		# TODO
+	end
+
+	describe '#specialized_template' do
+		# TODO
+	end
+
+	describe '#canonical' do
+		let (:structs) { find_all(cursor_canon, :cursor_struct) }
+
+		it "mathes 3 cursors" do
+			structs.size.should eq(3)
+		end
+
+		it "refers the first cursor as canonical one" do
+			structs[0].canonical.should eq(structs[0])
+			structs[1].canonical.should eq(structs[0])
+			structs[2].canonical.should eq(structs[0])
+		end
+	end
+
+	describe '#definition' do
+		let (:structs) { find_all(cursor_canon, :cursor_struct) }
+
+		it "mathes 3 cursors" do
+			structs.size.should eq(3)
+		end
+
+		it "refers the third cursor as definition one" do
+			structs[0].definition.should eq(structs[2])
+			structs[1].definition.should eq(structs[2])
+			structs[2].definition.should eq(structs[2])
+		end
+	end
+
+	describe '#template_kind' do
+		# TODO
+	end
+
+	describe '#access_specifier' do
+		let(:access_specifier_cursor) { find_matching(cursor_cxx) { |child, parent|
+				child.kind == :cursor_cxx_method and child.spelling == 'func_d' } }
+
+		it 'returns access specifier symbol', from_3_3: true do
+			access_specifier_cursor.access_specifier.should equal :private
+		end
+
+		it 'returns access specifier symbol(invalid, why?)', upto_3_2: true do
+			access_specifier_cursor.access_specifier.should equal :invalid
+		end
+	end
+
+	describe '#language' do
+		let(:c_language_cursor) { find_matching(cursor) { |c, p| c.kind == :cursor_struct } }
+		let(:cxx_language_cursor) { find_matching(cursor_cxx) { |c, p| c.kind == :cursor_struct } }
+
+		it 'returns :c if the cursor language is C' do
+			c_language_cursor.language.should equal :c
+		end
+
+		it 'returns :c_plus_plus if the cursor language is C++' do
+			cxx_language_cursor.language.should equal :c_plus_plus
+		end
+	end
+
+	describe '#translation_unit' do
+		let (:struct) { find_first(cursor, :cursor_struct) }
+
+		it "can find the first struct" do
+			struct.should_not equal(nil)
+		end
+
+		it "returns the translation unit that a cursor originated from" do
+			struct.translation_unit.should be_kind_of(TranslationUnit)
+		end
+	end
+
+	describe '#linkage' do
+		let (:ref) { find_first(cursor, :cursor_type_ref) }
+		let (:func) { find_first(cursor, :cursor_function) }
+
+		it "returns :external if the cursor is non-static function" do
+			func.linkage.should equal :external
+		end
+
+		it "returns :invalid if the cursor does not have linkage" do
+			ref.linkage.should equal :invalid
+		end
+	end
+
+	describe '#semantic_parent' do
+		let(:parent) { find_matching(cursor_cxx) { |child, parent|
+				child.kind == :cursor_cxx_method and child.spelling == 'func_d' and parent.spelling != 'D' } }
+
+		it 'returns base class as semantic parent' do
+			parent.semantic_parent.spelling.should eq('D')
+		end
+	end
+
+	describe '#lexical_parent' do
+		let(:parent) { find_matching(cursor_cxx) { |child, parent|
+				child.kind == :cursor_cxx_method and child.spelling == 'func_d' and parent.spelling != 'D' } }
+
+		it 'returns translation unit as lexical parent' do
+			parent.lexical_parent.kind.should eq(:cursor_translation_unit)
+		end
+	end
+
+	describe '#included_file' do
+		#TODO
+	end
+
+	describe '#definition?' do
+		let (:struct) { find_all(cursor_canon, :cursor_struct).at(2) }
+
+		it "checks cursor is a definition" do
+			struct.definition?.should be_true
+		end
+	end
+
+	describe '#usr' do
+		let (:func) { find_first(cursor, :cursor_function) }
+
+		it "returns something in string" do
+			func.usr.should be_kind_of(String)
+		end
+	end
+
+	describe '#variadic?', from_3_3: true do
+		let(:func) { find_matching(cursor_cxx) { |child, parent|
+				child.kind == :cursor_function and child.spelling == 'f_variadic' } }
+
+		it "checks cursor is a variadic function" do
+			func.variadic?.should be_true
+		end
+	end
+
+	describe '#referenced' do
+		let(:struct) { find_matching(cursor_cxx) { |child, parent|
+				child.kind == :cursor_struct and child.spelling == 'A' } }
+		let(:ref) { find_matching(cursor_cxx) { |child, parent|
+				child.kind == :cursor_type_ref and child.spelling == 'struct A' } }
+
+		it "returns a cursor that this cursor references" do
+			ref.referenced.should eq(struct)
+		end
+
+	end
+
+	describe '#hash' do
+		let (:func) { find_first(cursor, :cursor_function) }
+
+		it "computes hash for the cursor" do
+			func.hash.should be_kind_of(Fixnum)
+		end
+	end
+
+	describe '#availability' do
+		let (:func) { find_first(cursor, :cursor_function) }
+
+		it "returns :available for the cursor availability" do
+			func.availability.should equal(:available)
+		end
+	end
+
+	describe '#type' do
+		let (:field) { find_first(cursor, :cursor_field_decl) }
+
+		it "returns type for the cursor" do
+			field.type.should be_kind_of(Type)
+			field.type.kind.should equal(:type_int)
+		end
+	end
+
+	describe '#underlying_type' do
+		let (:typedef) { find_first(cursor_cxx, :cursor_typedef_decl) }
+
+		it "returns type that the cursor type is underlying" do
+			typedef.underlying_type.should be_kind_of(Type)
+			typedef.underlying_type.kind.should equal(:type_pointer)
+		end
+	end
+
+	describe '#enum_decl_integer_type' do
+		#TODO
+	end
+
+	describe '#platform_availability' do
+		#TODO
+	end
+
+	describe '#get_overridden_cursors' do
+		#TODO
+	end
 end