ghazel-ffi-clang 0.2.0.1

data/spec/clang/diagnostic_spec.rb

@@ -0,0 +1,89 @@
+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
+
+	it "calls dispose_diagnostic on GC" do
+		expect(Lib).to receive(:dispose_diagnostic).with(diagnostic).at_least(:once)
+		expect{diagnostic.free}.not_to raise_error
+	end
+
+	context "#self.default_display_opts" do
+		it "returns the set of display options" do
+			expect(FFI::Clang::Diagnostic.default_display_opts).to be_kind_of(Hash)
+			expect(FFI::Clang::Diagnostic.default_display_opts.keys.map(&:class).uniq).to eq([Symbol])
+			expect(FFI::Clang::Diagnostic.default_display_opts.values.uniq).to eq([true])
+		end
+	end
+
+	context "#fixits" do
+		it "returns the replacement information by Array of Hash" do
+			expect(diagnostic.fixits).to be_kind_of(Array)
+			expect(diagnostic.fixits.first).to be_kind_of(Hash)
+			expect(diagnostic.fixits.first[:text]).to eq('struct')
+			expect(diagnostic.fixits.first[:range]).to be_kind_of(SourceRange)
+		end
+	end
+
+	context "#children" do
+		it "returns child diagnostics by Array" do
+			expect(diagnostic.children).to be_kind_of(Array)
+			expect(diagnostic.children.first).to be_kind_of(Diagnostic)
+			expect(diagnostic.children.first.severity).to eq(:note)
+		end
+	end
+
+	context "#enable_option" do
+		it "returns the name of the command-line option that enabled this diagnostic" do
+			expect(diagnostics[3].enable_option).to be_kind_of(String)
+			expect(diagnostics[3].enable_option).to eq('-Wempty-body')
+		end
+	end
+
+	context "#disable_option" do
+		it "returns the name of the command-line option that disables this diagnostic" do
+			expect(diagnostics[3].disable_option).to be_kind_of(String)
+			expect(diagnostics[3].disable_option).to eq('-Wno-empty-body')
+		end
+	end
+
+	context "#category" do
+		it "returns the diagnostic category text" do
+			expect(diagnostic.category).to be_kind_of(String)
+			expect(diagnostic.category).to eq('Semantic Issue')
+		end
+	end
+
+	context "#category_id" do
+		it "returns the category number" do
+			expect(diagnostic.category_id).to be_kind_of(Integer)
+			expect(diagnostic.category_id).to eq(2)
+		end
+	end
+end

data/spec/clang/file_spec.rb

@@ -0,0 +1,84 @@
+# 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 'spec_helper'
+
+describe File do
+	let(:file_list) { Index.new.parse_translation_unit(fixture_path("list.c")).file(fixture_path("list.c")) }
+	let(:file_docs) { Index.new.parse_translation_unit(fixture_path("docs.c")).file(fixture_path("docs.h")) }
+
+	it "can be obtained from a translation unit" do
+		expect(file_list).to be_kind_of(FFI::Clang::File)
+	end
+
+	describe "#name" do
+		let(:name) { file_list.name }
+
+		it 'returns its file name' do
+			expect(name).to be_kind_of(String)
+			expect(name).to eq(fixture_path("list.c"))
+		end
+	end
+
+	describe "#to_s" do
+		let(:name) { file_list.to_s }
+
+		it 'returns its file name' do
+			expect(name).to be_kind_of(String)
+			expect(name).to eq(fixture_path("list.c"))
+		end
+	end
+
+	describe "#time" do
+		let(:time) { file_list.time }
+
+		it 'returns file time' do
+			expect(time).to be_kind_of(Time)
+		end
+	end
+
+	describe "#include_guarded?" do
+		it 'returns false if included file is notguarded' do
+			expect(file_list.include_guarded?).to be_false
+		end
+
+		it 'returns true if included file is guarded' do
+			expect(file_docs.include_guarded?).to be_true
+		end
+	end
+
+	describe "#device", from_3_3: true do
+		it 'returns device from CXFileUniqueID' do
+			expect(file_list.device).to be_kind_of(Integer)
+		end
+	end
+
+	describe "#inode", from_3_3: true do
+		it 'returns inode from CXFileUniqueID' do
+			expect(file_list.inode).to be_kind_of(Integer)
+		end
+	end
+
+	describe "#modification", from_3_3: true do
+		it 'returns modification time as Time from CXFileUniqueID' do
+			expect(file_list.modification).to be_kind_of(Time)
+		end
+	end
+end

data/spec/clang/index_spec.rb

@@ -0,0 +1,70 @@
+# 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 'spec_helper'
+
+describe Index do
+	before :all do
+		FileUtils.mkdir_p TMP_DIR
+	end
+
+	after :all do
+		FileUtils.rm_rf TMP_DIR
+	end
+
+	let(:index) { Index.new }
+
+	it "calls dispose_index_debug_unit on GC" do
+		expect(Lib).to receive(:dispose_index).with(index).at_least(:once)
+		expect{index.free}.not_to raise_error
+	end
+
+	describe '#parse_translation_unit' do
+		it "can parse a source file" do
+			tu = index.parse_translation_unit fixture_path("a.c")
+			expect(tu).to be_kind_of(TranslationUnit)
+		end
+
+		it "raises error when file is not found" do
+			expect { index.parse_translation_unit fixture_path("xxxxxxxxx.c") }.to raise_error
+		end
+
+		it "can handle command line options" do
+		   expect{index.parse_translation_unit(fixture_path("a.c"), ["-std=c++11"])}.not_to raise_error
+		end
+	end
+
+	describe '#create_translation_unit' do
+		before :all do
+			system("clang -c #{fixture_path('simple.c')} -emit-ast -o #{TMP_DIR}/simple.ast")
+		end
+
+		it "can create translation unit from a ast file" do
+			expect(FileTest.exist?("#{TMP_DIR}/simple.ast")).to be_true
+			tu = index.create_translation_unit "#{TMP_DIR}/simple.ast"
+			expect(tu).to be_kind_of(TranslationUnit)
+		end
+
+		it "raises error when file is not found" do
+			expect(FileTest.exist?('not_found.ast')).to be_false
+			expect { index.create_translation_unit 'not_found.ast' }.to raise_error
+		end
+	end
+end

data/spec/clang/source_location_spec.rb

@@ -0,0 +1,140 @@
+# Copyright, 2010-2012 by Jari Bakken.
+# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2013, by Garry C. Marshall. <http://www.meaningfulname.net>
+# 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 'spec_helper'
+
+describe SourceLocation do
+	let(:tu)                   { Index.new.parse_translation_unit(fixture_path("list.c")) }
+	let(:tu_location)          { tu.cursor.location }
+	let(:diagnostic_location)  { tu.diagnostics.first.location }
+	let(:loc1_tu)              { Index.new.parse_translation_unit(fixture_path("location1.c")) }
+	let(:loc1_cursor)          { find_first(loc1_tu.cursor, :cursor_function) }
+	let(:docs_cursor)          { Index.new.parse_translation_unit(fixture_path("docs.c")).cursor }
+
+	it "should have a nil File if the SourceLocation is for a Translation Unit" do
+		expect(tu_location.file).to be_nil
+	end
+
+	it "should provide a File, line and column for a Diagnostic" do
+		expect(diagnostic_location.file).to eq(fixture_path("list.c"))
+		expect(diagnostic_location.line).to equal(5)
+		expect(diagnostic_location.column).to equal(9)
+	end
+
+	it "should be ExpansionLocation" do
+		expect(tu_location).to be_kind_of(SourceLocation)
+		expect(tu_location).to be_kind_of(ExpansionLocation)
+	end
+
+	describe "Null Location" do
+		let(:null_location) { SourceLocation.null_location }
+		it "can be a null location" do
+			expect(null_location).to be_kind_of(SourceLocation)
+			expect(null_location.file).to be_nil
+			expect(null_location.line).to eq(0)
+			expect(null_location.column).to eq(0)
+			expect(null_location.offset).to eq(0)
+		end
+
+		it "is null?" do
+			expect(null_location.null?).to equal(true)
+		end
+
+		it "compares as equal to another null location instance" do
+			expect(null_location).to eq(SourceLocation.null_location)
+		end
+	end
+
+	describe "#from_main_file?", from_3_4: true do
+		it "returns true if the cursor location is in main file" do
+			expect(loc1_cursor.location.from_main_file?).to be_true
+		end
+
+		it "returns false if the cursor location is not in main file" do
+			expect(docs_cursor.location.from_main_file?).to be_false
+		end
+	end
+
+	describe "#in_system_header?", from_3_4: true do
+		it "returns false if the cursor location is not in system header" do
+			expect(loc1_cursor.location.in_system_header?).to be_false
+		end
+	end
+
+	describe "#expansion_location" do
+		let (:expansion_location) { loc1_cursor.location.expansion_location }
+
+		it "should be ExpansionLocaion" do
+			expect(expansion_location).to be_kind_of(SourceLocation)
+			expect(expansion_location).to be_kind_of(ExpansionLocation)
+		end
+
+		it "returns source location that does not care a # line directive" do
+			expect(expansion_location.line).to eq(3)
+		end
+	end
+
+	describe "#presumed_location" do
+		let (:presumed_location) { loc1_cursor.location.presumed_location }
+
+		it "should be FileLocaion" do
+			expect(presumed_location).to be_kind_of(SourceLocation)
+			expect(presumed_location).to be_kind_of(PresumedLocation)
+		end
+
+		it "returns preprocessed filename" do
+			expect(presumed_location.filename).to eq("dummy.c")
+		end
+
+		it "returns source location specified by a # line directive" do
+			expect(presumed_location.line).to eq(124)
+		end
+	end
+
+	describe "#file_location", from_3_3: true do
+		let (:file_location) { loc1_cursor.location.file_location }
+
+		it "should be FileLocaion" do
+			expect(file_location).to be_kind_of(SourceLocation)
+			expect(file_location).to be_kind_of(FileLocation)
+		end
+
+		it "returns source location that does not care a # line directive" do
+			expect(file_location.line).to eq(3)
+		end
+	end
+
+	describe "#spelling_location" do
+		let (:spelling_location) { loc1_cursor.location.spelling_location }
+
+		it "should be SpellingLocaion" do
+			expect(spelling_location).to be_kind_of(SourceLocation)
+			expect(spelling_location).to be_kind_of(SpellingLocation)
+		end
+
+		it "returns source location that does not care a # line directive" do
+			expect(spelling_location.line).to eq(3)
+		end
+	end
+
+end

data/spec/clang/source_range_spec.rb

@@ -0,0 +1,76 @@
+# 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 'spec_helper'
+
+describe SourceRange do
+	let(:tu) { Index.new.parse_translation_unit(fixture_path("list.c")) }
+	let(:tu_range) { tu.cursor.extent }
+
+	it "can be obtained from a cursor" do
+		expect(tu_range).to be_kind_of(SourceRange)
+		expect(tu_range.null?).to be_false
+	end
+
+	it "has start and end source location" do
+		expect(tu_range.start).to be_kind_of(SourceLocation)
+		expect(tu_range.start.null?).to be_false
+		expect(tu_range.end).to be_kind_of(SourceLocation)
+		expect(tu_range.end.null?).to be_false
+	end
+
+	describe "Null Range" do
+		let(:null_range) { SourceRange.null_range }
+		it "can be a null range" do
+			expect(null_range).to be_kind_of(SourceRange)
+		end
+
+		it "is null?" do
+			expect(null_range.null?).to equal(true)
+		end
+
+		it "has null locations" do
+		    expect(null_range.start.null?).to be_true
+		    expect(null_range.end.null?).to be_true
+		end
+
+		it "compares as equal to another null range instance" do
+			expect(null_range).to eq(SourceRange.null_range)
+		end
+	end
+
+    describe "Get Range" do
+        let(:range) { SourceRange.new(tu_range.start, tu_range.end) }
+
+        it "can be obtained from two source locations" do
+			expect(range).to be_kind_of(SourceRange)
+			expect(range.null?).to be_false
+        end
+
+        it "is same to original source range" do
+			expect(range).to eq(tu_range)
+        end
+
+        it "is same to original source range's locations" do
+			expect(range.start).to eq(tu_range.start)
+			expect(range.end).to eq(tu_range.end)
+        end
+    end
+end