ffi-clang 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWQwOTY2ZDA4ZWEzMjMwZDExZDY4ZDI3MDNmM2ZlYWJkYzFmZmI3Nw==
+    Njk3ODJkZDU2YzlmODI2YTQ2ZmJiYzI5ZjE2OWY5MWEyZDAwNWM5Ng==
   data.tar.gz: !binary |-
-    NzgyMmY3OTRjZGYxM2ZkNTQwNmZjYjU0YjE2ZDAwM2IwOThmMDIxZA==
+    NDEzNjk5MzM0NmJjY2M4NDVjMjBlNjc3Y2M5Y2QwOTdiZGRiMGRiOA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MTI0NGZlMzYyMGRmYTdhOGQwZDlmYzQzNTA0M2U4NmZlMmZjYjQ2ZDEzOGRk
-    ODE3NjIyMzliOGQyOTBhOWZiOGFhMmVkZjA5MDUwNmYxZjUxMWI3NDJhMTky
-    ZTc0ODc2OTJmNjQ4NmQxMDMwYjdlMjEzM2M0MTFjYjRjNDIxM2E=
+    NmViOGUxYWIwNDJmMWEyMTk1ZDkzODA3NmQwNTEyMmRkODI5YmM0ZmNhYWM2
+    OWI2NjdkMGMwMTU0MGNkOWJiYTA4YzVhZGEzNjZhMjExMjU3ZGE4Yjg0ZTI3
+    MWJiOWFiZWY4NWQ3NTE4NjQ3NTAyMThmOWFjNzFiZjI0NDk2OGQ=
   data.tar.gz: !binary |-
-    NDI0MDJhYThkZGRiNGQ3MjMwYWYyNjU4NzI2NmY0NzMzOTIwZGI1OGQyY2Rj
-    YzM2MjEzMTJmMmRjMzkwYmJlZjIxNzZhZDI2OGI2YTY0ZjdlYjkyODkwNjQ0
-    OWQwNDE2ZGE4ZDE4YmRjOTZjN2YzZWQ2NDdkZWM1ZjhiZDIwNmQ=
+    ZDQyZWRiYzhiYjcxYmYyYjc2OGNiNDM1MTMyNWVkMmRjMjgwMDgyNDNiNmNj
+    OTU2YWU5NWVkNzgzMjBmM2YzMDQ4ZjU4ZDkxOWIwMTI2ODNiNmI2MjY3ZTIw
+    YTI4MDM2MzZlNzUxNmQ4MTEyNmZlMzMxYzIzNTI0ZmNiOWE1YWE=

data/README.md

@@ -4,6 +4,9 @@ Ruby FFI bindings for libclang. WIP.
 
 http://llvm.org/devmtg/2010-11/Gregor-libclang.pdf
 
+[![Build Status](https://secure.travis-ci.org/ioquatix/ffi-clang.png)](http://travis-ci.org/ioquatix/ffi-clang)
+[![Code Climate](https://codeclimate.com/github/ioquatix/ffi-clang.png)](https://codeclimate.com/github/ioquatix/ffi-clang)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,6 +37,7 @@ TODO: Write usage instructions here
 
 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>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/ffi/clang.rb

@@ -46,6 +46,8 @@ 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'
+require 'ffi/clang/cursor'
+require 'ffi/clang/source_location'
+require 'ffi/clang/source_range'
+require 'ffi/clang/unsaved_file'
 

data/lib/ffi/clang/cursor.rb

@@ -0,0 +1,110 @@
+# 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/cursor'
+require 'ffi/clang/source_location'
+
+module FFI
+	module Clang
+		class Cursor
+			def self.null_cursor
+				Cursor.new Lib.get_null_cursor
+			end
+
+			def initialize( cxcursor )
+				@cursor = cxcursor
+			end
+
+			def null?
+				Lib.cursor_is_null(@cursor) != 0
+			end
+
+			def declaration?
+				Lib.is_declaration(kind) != 0
+			end
+
+			def reference?
+				Lib.is_reference(kind) != 0
+			end
+
+			def expression?
+				Lib.is_expression(kind) != 0
+			end
+
+			def statement?
+				Lib.is_statement(kind) != 0
+			end
+
+			def attribute?
+				Lib.is_attribute(kind) != 0
+			end
+
+			def invalid?
+				Lib.is_invalid(kind) != 0
+			end
+
+			def translation_unit?
+				Lib.is_translation_unit(kind) != 0
+			end
+
+			def preprocessing?
+				Lib.is_preprocessing(kind) != 0
+			end
+
+			def unexposed?
+				Lib.is_unexposed(kind) != 0
+			end
+
+			def location
+				SourceLocation.new(Lib.get_cursor_location(@cursor))
+			end
+
+			def extent
+				SourceRange.new(Lib.get_cursor_extent(@cursor))
+			end
+
+			def displayName
+				Lib.extract_string Lib.get_cursor_display_name(@cursor)
+			end
+
+			def spelling
+				Lib.extract_string Lib.get_cursor_spelling(@cursor)
+			end
+
+			def kind
+				@cursor[:kind]
+			end
+
+			def visit_children(&block)
+				adapter = Proc.new do | cxcursor, parent_cursor, unused |
+					block.call Cursor.new(cxcursor), Cursor.new(parent_cursor)
+				end
+				Lib.visit_children(@cursor, adapter, nil)
+			end
+
+			attr_reader :cursor
+
+			def ==(other)
+				Lib.are_equal(@cursor, other.cursor) != 0
+			end
+		end
+	end
+end

data/lib/ffi/clang/diagnostic.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Copyright, 2010-2012 by Jari Bakken.
 # Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
@@ -20,21 +21,17 @@
 # THE SOFTWARE.
 
 require 'ffi/clang/lib/diagnostic'
+require 'ffi/clang/source_range'
 
 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
@@ -52,13 +49,17 @@ module FFI
 				Lib.get_string Lib.get_diagnostic_spelling(self)
 			end
 
+			def location
+				sl = Lib.get_diagnostic_location(self)
+				SourceLocation.new sl
+			end
+
 			def fixits
 				raise NotImplementedError
 				# unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diag);
 				# – CXString clang_getDiagnosticFixIt(CXDiagnostic Diag,
 				#                                     unsigned FixIt,
 				#                                     CXSourceRange *ReplacementRange);
-
 			end
 
 			def ranges

data/lib/ffi/clang/index.rb

@@ -32,10 +32,11 @@ module FFI
 				Lib.dispose_index_debug(pointer)
 			end
 
-			def parse_translation_unit(source_file, command_line_args = nil, opts = {})
+			def parse_translation_unit(source_file, command_line_args = nil, unsaved = [], opts = {})
 				command_line_args = Array(command_line_args)
+				unsaved_files = unsaved_pointer_from(unsaved)
 
-				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))
+				translation_unit_pointer = Lib.parse_translation_unit(self, source_file, args_pointer_from(command_line_args), command_line_args.size, unsaved_files, unsaved.length, options_bitmask_from(opts))
 
 				raise Error, "error parsing #{source_file.inspect}" unless translation_unit_pointer
 
@@ -59,6 +60,20 @@ module FFI
 				Lib.bitmask_from Lib::TranslationUnitFlags, opts
 			end
 
+			def unsaved_pointer_from(unsaved)
+				return nil if unsaved.length == 0
+
+				vec = MemoryPointer.new(Lib::CXUnsavedFile, unsaved.length)
+
+				unsaved.each_with_index do |file, i|
+					uf = Lib::CXUnsavedFile.new(vec + i * Lib::CXUnsavedFile.size)
+					uf[:filename] = MemoryPointer.from_string(file.filename)
+					uf[:contents] = MemoryPointer.from_string(file.contents)
+					uf[:length] = file.contents.length
+				end
+
+				vec
+			end
 		end
 	end
 end

data/lib/ffi/clang/lib.rb

@@ -34,7 +34,7 @@ module FFI
 			end
 
 			ffi_lib libs
-			
+
 			def self.bitmask_from(enum, opts)
 				bitmask = 0
 

data/lib/ffi/clang/lib/cursor.rb

@@ -0,0 +1,72 @@
+# 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>
+# 
+# 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/diagnostic'
+
+module FFI
+	module Clang
+		module Lib
+			enum :kind, [:cursor_struct, 2,
+				:cursor_function, 8,
+				:cursor_invalid_file, 70,
+				:cursor_translation_unit, 300]
+
+			class CXCursor < FFI::Struct
+				layout(
+					:kind, :kind,
+					:xdata, :int,
+					:data, [:pointer, 3]
+				)
+			end
+
+			attach_function :get_translation_unit_cursor, :clang_getTranslationUnitCursor, [:CXTranslationUnit], CXCursor.by_value
+
+			attach_function :get_null_cursor, :clang_getNullCursor, [], CXCursor.by_value
+
+			attach_function :cursor_is_null, :clang_Cursor_isNull, [CXCursor.by_value], :int
+
+			attach_function :get_cursor_location, :clang_getCursorLocation, [CXCursor.by_value], CXSourceLocation.by_value
+			attach_function :get_cursor_extent, :clang_getCursorExtent, [CXCursor.by_value], CXSourceRange.by_value
+			attach_function :get_cursor_display_name, :clang_getCursorDisplayName, [CXCursor.by_value], CXString.by_value
+			attach_function :get_cursor_spelling, :clang_getCursorSpelling, [CXCursor.by_value], CXString.by_value
+			
+			attach_function :are_equal, :clang_equalCursors, [CXCursor.by_value, CXCursor.by_value], :uint
+
+			attach_function :is_declaration, :clang_isDeclaration, [:kind], :uint
+			attach_function :is_reference, :clang_isReference, [:kind], :uint
+			attach_function :is_expression, :clang_isExpression, [:kind], :uint
+			attach_function :is_statement, :clang_isStatement, [:kind], :uint
+			attach_function :is_attribute, :clang_isAttribute, [:kind], :uint
+			attach_function :is_invalid, :clang_isInvalid, [:kind], :uint
+			attach_function :is_translation_unit, :clang_isTranslationUnit, [:kind], :uint
+			attach_function :is_preprocessing, :clang_isPreprocessing, [:kind], :uint
+			attach_function :is_unexposed, :clang_isUnexposed, [:kind], :uint
+
+			enum :child_visit_result, [:break, :continue, :recurse]
+
+			callback :visit_children_function, [CXCursor.by_value, CXCursor.by_value, :pointer], :child_visit_result
+			attach_function :visit_children, :clang_visitChildren, [CXCursor.by_value, :visit_children_function, :pointer], :uint
+		end
+	end
+end
+

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

@@ -1,16 +1,16 @@
 # 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
@@ -20,55 +20,47 @@
 # THE SOFTWARE.
 
 require 'ffi/clang/lib/translation_unit'
+require 'ffi/clang/lib/source_location'
 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,
+					:ptr_data, [:pointer, 2],
 					: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

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

@@ -25,11 +25,19 @@ require 'ffi/clang/lib/translation_unit'
 module FFI
 	module Clang
 		module Lib
+			class CXUnsavedFile < FFI::Struct
+				layout(
+					:filename, :pointer,
+					:contents, :pointer,
+					:length, :ulong
+				)
+			end
+
 			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

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

@@ -25,7 +25,7 @@ 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

data/lib/ffi/clang/lib/source_location.rb

@@ -0,0 +1,35 @@
+# 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
+			class CXSourceLocation < FFI::Struct
+				layout(
+					:ptr_data, [:pointer, 2],
+					:int_data, :uint
+				)
+			end
+
+			attach_function :get_expansion_location, :clang_getExpansionLocation, [CXSourceLocation.by_value, :pointer, :pointer, :pointer, :pointer], :void
+		end
+	end
+end

data/lib/ffi/clang/lib/source_range.rb

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+# 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>
+# 
+# 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/source_location'
+
+module FFI
+	module Clang
+		module Lib
+			class CXSourceRange < FFI::Struct
+				layout(
+					:ptr_data, [:pointer, 2],
+					:begin_int_data, :uint,
+					:end_int_data, :uint
+				)
+			end
+
+			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
+		end
+	end
+end

data/lib/ffi/clang/source_location.rb

@@ -0,0 +1,47 @@
+# 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/source_location'
+require 'ffi/clang/lib/file'
+
+module FFI
+	module Clang
+		class SourceLocation
+			def initialize(location)
+				@location = location
+
+				cxfile = MemoryPointer.new :pointer
+				line   = MemoryPointer.new :uint
+				column = MemoryPointer.new :uint
+				offset = MemoryPointer.new :uint
+
+				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)
+				@column = column.get_uint(0)
+				@offset = offset.get_uint(0)
+			end
+
+			attr_reader :file, :line, :column, :offset
+		end
+	end
+end

data/lib/ffi/clang/source_range.rb

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+# 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>
+# 
+# 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 SourceRange
+			def initialize(range)
+				@range = range
+			end
+
+			def start
+				SourceLocation.new(Lib.get_range_start @range)
+			end
+
+			def end
+				SourceLocation.new(Lib.get_range_end @range)
+			end
+		end
+	end
+end

data/lib/ffi/clang/translation_unit.rb

@@ -20,6 +20,7 @@
 # THE SOFTWARE.
 
 require 'ffi/clang/lib/translation_unit'
+require 'ffi/clang/cursor'
 
 module FFI
 	module Clang
@@ -40,6 +41,9 @@ module FFI
 				end
 			end
 
+			def cursor
+				Cursor.new(Lib.get_translation_unit_cursor(self))
+			end
 		end
 	end
 end

data/lib/ffi/clang/unsaved_file.rb

@@ -0,0 +1,33 @@
+# -*- 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
+# 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 UnsavedFile
+			def initialize(filename, contents)
+				@filename = filename
+				@contents = contents
+			end
+
+			attr_accessor :filename, :contents
+		end
+	end
+end

data/lib/ffi/clang/version.rb

@@ -21,6 +21,6 @@
 
 module FFI
 	module Clang
-		VERSION = "0.1.0"
+		VERSION = "0.1.1"
 	end
 end

data/spec/clang/cursor_spec.rb

@@ -0,0 +1,147 @@
+# 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>
+# 
+# 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'
+
+def find_first(cursor, kind)
+	first = nil
+
+	cursor.visit_children do |cursor, parent|
+		if (cursor.kind == kind)
+			first = cursor
+			:break
+		else
+			:recurse
+		end
+	end
+
+	first
+end
+
+describe Cursor do
+	let(:cursor) { Index.new.parse_translation_unit(fixture_path("list.c")).cursor }
+
+	it "can be obtained from a translation unit" do
+		cursor.should be_kind_of(Cursor)
+		cursor.kind.should equal(:cursor_translation_unit)
+		cursor.null?.should equal(false)
+		cursor.translation_unit?.should equal(true)
+	end
+
+	it "returns the source location of the cursor" do
+		location = cursor.location
+		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)
+
+		extent.start.file.should eq(fixture_path("list.c"))
+		extent.start.line.should equal(1)
+
+		extent.end.file.should eq(fixture_path("list.c"))
+		extent.end.line.should equal(10)
+	end
+
+	it "returns the path of the translation unit for the translation unit cursor" do
+		cursor.displayName.should eq(fixture_path("list.c"))
+		cursor.spelling.should eq(fixture_path("list.c"))
+	end
+
+	it "allows us to visit its children" do
+		counter = 0
+		cursor.visit_children do |cursor, parent|
+			counter += 1
+			:recurse
+		end
+		counter.should_not equal(0)
+	end
+
+	describe "Null Cursor" do
+		it "can be a null cursor" do
+			Cursor.null_cursor.should be_kind_of(Cursor)
+			Cursor.null_cursor.kind.should equal(:cursor_invalid_file)
+		end
+
+		it "is null?" do
+			Cursor.null_cursor.null?.should equal(true)
+		end
+
+		it "is invalid?" do
+			Cursor.null_cursor.invalid?.should equal(true)
+		end
+
+		it "compares as equal to another null cursor instance" do
+			Cursor.null_cursor.should eq(Cursor.null_cursor)
+		end
+
+		it "should not equal a Translation Unit cursor" do
+			Cursor.null_cursor.should_not eq(cursor)
+		end
+	end
+
+	describe "Function Cursors" do
+		let (:func) { find_first(cursor, :cursor_function) }
+
+		it "is not invalid?" do
+			func.invalid?.should equal(false)
+		end
+
+		it "can find the first function declaration" do
+			func.should_not equal(nil)
+			func.kind.should equal(:cursor_function)
+		end
+
+		it "has an extent representing the bounds of the function" do
+			func.extent.should be_kind_of(SourceRange)
+			func.extent.start.line.should equal(5)
+			func.extent.end.line.should equal(5)
+		end
+
+		it "returns the name of the function" do
+			func.spelling.should eq("sum")
+			func.displayName.should eq("sum(union List *)")
+		end
+	end
+
+	describe "Struct Cursors" do
+		let (:struct) { find_first(cursor, :cursor_struct) }
+
+		it "can find the first struct" do
+			struct.should_not equal(nil)
+			struct.kind.should equal(:cursor_struct)
+		end
+
+		it "has an extent representing the bounds of the struct" do
+			struct.extent.start.line.should equal(1)
+			struct.extent.end.line.should equal(4)
+		end
+
+		it "returns the name of the struct" do
+			struct.spelling.should eq("List")
+			struct.displayName.should eq("List")
+		end
+
+	end
+	
+end

data/spec/clang/source_location_spec.rb

@@ -0,0 +1,40 @@
+# 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>
+# 
+# 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 }
+
+	it "should have a nil File if the SourceLocation is for a Translation Unit" do
+		tu_location.file.should == nil
+	end
+
+	it "should provide a File, line and column for a Diagnostic" do
+		diagnostic_location.file.should eq(fixture_path("list.c"))
+		diagnostic_location.line.should equal(5)
+		diagnostic_location.column.should equal(9)
+	end
+
+end

data/spec/clang/translation_unit_spec.rb

@@ -8,4 +8,12 @@ describe TranslationUnit do
 		diags.should be_kind_of(Array)
 		diags.should_not be_empty
 	end
+
+	it "returns a list of diagnostics from an unsaved file" do
+		file = UnsavedFile.new("a.c", File.read(fixture_path("a.c")))
+		tu = Index.new.parse_translation_unit("a.c", nil,[file])
+		diags = tu.diagnostics
+		diags.should be_kind_of(Array)
+		diags.should_not be_empty
+	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-clang
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jari Bakken
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-13 00:00:00.000000000 Z
+date: 2013-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -83,18 +83,27 @@ files:
 - Rakefile
 - ffi-clang.gemspec
 - lib/ffi/clang.rb
+- lib/ffi/clang/cursor.rb
 - lib/ffi/clang/diagnostic.rb
 - lib/ffi/clang/index.rb
 - lib/ffi/clang/lib.rb
+- lib/ffi/clang/lib/cursor.rb
 - lib/ffi/clang/lib/diagnostic.rb
 - lib/ffi/clang/lib/file.rb
 - lib/ffi/clang/lib/index.rb
+- lib/ffi/clang/lib/source_location.rb
+- lib/ffi/clang/lib/source_range.rb
 - lib/ffi/clang/lib/string.rb
 - lib/ffi/clang/lib/translation_unit.rb
+- lib/ffi/clang/source_location.rb
+- lib/ffi/clang/source_range.rb
 - lib/ffi/clang/translation_unit.rb
+- lib/ffi/clang/unsaved_file.rb
 - lib/ffi/clang/version.rb
+- spec/clang/cursor_spec.rb
 - spec/clang/diagnostic_spec.rb
 - spec/clang/index_spec.rb
+- spec/clang/source_location_spec.rb
 - spec/clang/translation_unit_spec.rb
 - spec/fixtures/a.c
 - spec/fixtures/list.c
@@ -124,8 +133,10 @@ signing_key:
 specification_version: 4
 summary: Ruby FFI bindings for libclang C interface.
 test_files:
+- spec/clang/cursor_spec.rb
 - spec/clang/diagnostic_spec.rb
 - spec/clang/index_spec.rb
+- spec/clang/source_location_spec.rb
 - spec/clang/translation_unit_spec.rb
 - spec/fixtures/a.c
 - spec/fixtures/list.c