ffi-clang 0.2.0 → 0.2.1

data/lib/ffi/clang/source_range.rb

@@ -2,6 +2,7 @@
 # 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
@@ -21,19 +22,39 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'ffi/clang/lib/source_range'
+
 module FFI
 	module Clang
 		class SourceRange
-			def initialize(range)
-				@range = range
+			def self.null_range
+				SourceRange.new Lib.get_null_range
+			end
+
+			def initialize(range_or_begin_location, end_location = nil)
+				if end_location.nil?
+					@range = range_or_begin_location
+				else
+					@range = Lib.get_range(range_or_begin_location.location, end_location.location)
+				end
 			end
 
 			def start
-				SourceLocation.new(Lib.get_range_start @range)
+				ExpansionLocation.new(Lib.get_range_start @range)
 			end
 
 			def end
-				SourceLocation.new(Lib.get_range_end @range)
+				ExpansionLocation.new(Lib.get_range_end @range)
+			end
+
+			def null?
+				Lib.range_is_null(@range) != 0
+			end
+
+			attr_reader :range
+
+			def ==(other)
+				Lib.equal_range(@range, other.range) != 0
 			end
 		end
 	end

data/lib/ffi/clang/token.rb

@@ -0,0 +1,95 @@
+# 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/token'
+require 'ffi/clang/lib/cursor'
+require 'ffi/clang/source_location'
+
+module FFI
+	module Clang
+		class Tokens < AutoPointer
+			include Enumerable
+
+			attr_reader :size
+			attr_reader :tokens
+
+			def initialize(pointer, token_size, translation_unit)
+				ptr = Lib::TokensPointer.new(pointer,token_size, translation_unit)
+				super ptr
+
+				@translation_unit = translation_unit
+				@size = token_size
+
+				@tokens = []
+				cur_ptr = pointer
+				token_size.times {
+					@tokens << Token.new(cur_ptr, translation_unit)
+					cur_ptr += Lib::CXToken.size
+				}
+			end
+
+			def self.release(pointer)
+				Lib.dispose_tokens(pointer, pointer.token_size, pointer.translation_unit)
+			end
+
+			def each(&block)
+				@tokens.each do |token|
+					block.call(token)
+				end
+			end
+
+			def cursors
+				ptr = MemoryPointer.new(Lib::CXCursor, @size)
+				Lib.annotate_tokens(@translation_unit, self, @size, ptr)
+
+				cur_ptr = ptr
+				arr = []
+				@size.times {
+					arr << Cursor.new(cur_ptr, @translation_unit)
+					cur_ptr += Lib::CXCursor.size
+				}
+				arr
+			end
+		end
+
+		class Token
+			def initialize(token, translation_unit)
+				@token = token
+				@translation_unit = translation_unit
+			end
+
+			def kind
+				Lib.get_token_kind(@token)
+			end
+
+			def spelling
+				Lib.extract_string Lib.get_token_spelliing(@translation_unit, @token)
+			end
+
+			def location
+				ExpansionLocation.new Lib.get_token_location(@translation_unit, @token)
+			end
+
+			def extent
+				SourceRange.new Lib.get_token_extent(@translation_unit, @token)
+			end
+		end
+	end
+end

data/lib/ffi/clang/translation_unit.rb

@@ -1,5 +1,6 @@
 # Copyright, 2010-2012 by Jari Bakken.
 # Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 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
@@ -20,7 +21,10 @@
 # THE SOFTWARE.
 
 require 'ffi/clang/lib/translation_unit'
+require 'ffi/clang/lib/inclusions'
 require 'ffi/clang/cursor'
+require 'ffi/clang/file'
+require 'ffi/clang/token'
 
 module FFI
 	module Clang
@@ -34,6 +38,35 @@ module FFI
 				Lib.dispose_translation_unit(pointer)
 			end
 
+			def self.default_editing_translation_unit_options
+				bitmask = Lib.default_editing_translation_unit_options
+				Lib.opts_from Lib::TranslationUnitFlags, bitmask
+			end
+
+			def default_save_options
+				bitmask = Lib.default_save_options(self)
+				Lib.opts_from Lib::SaveTranslationUnitFlags, bitmask
+			end
+
+			def save(filename, opts = {})
+				ret = Lib.save_translation_unit(self, filename, 0)
+				sym = Lib::SaveError[ret]
+				raise Error, "unknown return values: #{ret} #{sym.inspect}" unless sym
+				raise Error, "save error: #{sym.inspect}, filename: #{filename}" if sym != :none
+			end
+
+			def default_reparse_options
+				bitmask = Lib.default_save_options(self)
+				Lib.opts_from Lib::ReparseFlags, bitmask
+			end
+
+			def reparse(unsaved = [], opts = {})
+				unsaved_files = UnsavedFile.unsaved_pointer_from(unsaved)
+				if Lib.reparse_translation_unit(self, unsaved.size, unsaved_files, 0) != 0
+					raise Error, "reparse error"
+				end
+			end
+
 			def diagnostics
 				n = Lib.get_num_diagnostics(self)
 			
@@ -42,8 +75,91 @@ module FFI
 				end
 			end
 
-			def cursor
-				Cursor.new(Lib.get_translation_unit_cursor(self), self)
+			def cursor(location = nil)
+				if location.nil?
+					Cursor.new Lib.get_translation_unit_cursor(self), self
+				else
+					Cursor.new Lib.get_cursor(self, location.location), self
+				end
+			end
+
+			def location(file, line, column)
+				ExpansionLocation.new Lib.get_location(self, file, line, column)
+			end
+
+			def location_offset(file, offset)
+				ExpansionLocation.new Lib.get_location_offset(self, file, offset)
+			end
+
+			def file(file_name)
+				File.new(Lib.get_file(self, file_name), self)
+			end
+
+			def spelling
+				Lib.get_translation_unit_spelling(self)
+			end
+
+			def resource_usage
+				FFI::Clang::TranslationUnit::ResourceUsage.new Lib.resource_usage(self)
+			end
+
+			def tokenize(range)
+				token_ptr = MemoryPointer.new :pointer
+				uint_ptr = MemoryPointer.new :uint
+				Lib.tokenize(self, range.range, token_ptr, uint_ptr)
+				Tokens.new(token_ptr.get_pointer(0), uint_ptr.get_uint(0), self)
+			end
+
+			def code_complete(source_file, line, column, unsaved = [], opts = nil)
+				opts = CodeCompletion.default_code_completion_options if opts.nil?
+				unsaved_files = UnsavedFile.unsaved_pointer_from(unsaved)
+				option_bitmask = Lib.bitmask_from(Lib::CodeCompleteFlags, opts)
+				ptr = Lib.code_complete_at(self, source_file, line, column, unsaved_files, unsaved.length, option_bitmask)
+				CodeCompletion::Results.new ptr, self
+			end
+
+			def inclusions(&block)
+				adapter = Proc.new do |included_file, inclusion_stack, include_len, unused|
+					file = Lib.extract_string Lib.get_file_name(included_file)
+					cur_ptr = inclusion_stack
+					inclusions = []
+					include_len.times {
+						inclusions << SourceLocation.new(Lib::CXSourceLocation.new(cur_ptr))
+						cur_ptr += Lib::CXSourceLocation.size
+					}
+					block.call file, inclusions
+				end
+				
+				Lib.get_inclusions(self, adapter, nil)
+			end
+
+			class ResourceUsage < AutoPointer
+				def initialize(resource_usage)
+					# CXResourceUsage is returned by value and should be freed explicitly.
+					# Get FFI::pointer of the data so that the data is handled by AutoPointer.
+					pointer = FFI::Pointer.new(resource_usage.to_ptr)
+					super(pointer)
+					@resource_usage = resource_usage
+				end
+
+				def self.release(pointer)
+					# clang_disposeCXTUResourceUsage requires value type, so create it by pointer
+					Lib.dispose_resource_usage(Lib::CXTUResourceUsage.new(pointer))
+				end
+
+				def self.name(kind)
+					Lib.resource_usage_name(kind)
+				end
+
+				def entries
+					ary = []
+					ptr = @resource_usage[:entries]
+					@resource_usage[:numEntries].times {
+						ary << Lib::CXTUResourceUsageEntry.new(ptr)
+						ptr += Lib::CXTUResourceUsageEntry.size
+					}
+					ary
+				end
 			end
 		end
 	end

data/lib/ffi/clang/type.rb

@@ -1,4 +1,5 @@
 # Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 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
@@ -18,9 +19,13 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'ffi/clang/cursor'
+
 module FFI
 	module Clang
 		class Type
+			attr_reader :type
+
 			def initialize(type, translation_unit)
 				@type = type
 				@translation_unit = translation_unit
@@ -58,10 +63,22 @@ module FFI
 				Type.new Lib.get_canonical_type(@type), @translation_unit
 			end
 
+			def class_type
+				Type.new Lib.type_get_class_type(@type), @translation_unit
+			end
+
 			def const_qualified?
 				Lib.is_const_qualified_type(@type) != 0
 			end
 
+			def volatile_qualified?
+				Lib.is_volatile_qualified_type(@type) != 0
+			end
+
+			def restrict_qualified?
+				Lib.is_restrict_qualified_type(@type) != 0
+			end
+
 			def arg_type(i)
 				Type.new Lib.get_arg_type(@type, i), @translation_unit
 			end
@@ -69,6 +86,50 @@ module FFI
 			def result_type
 				Type.new Lib.get_result_type(@type), @translation_unit
 			end
+
+			def element_type
+				Type.new Lib.get_element_type(@type), @translation_unit
+			end
+
+			def num_elements
+				Lib.get_num_elements(@type)
+			end
+
+			def array_element_type
+				Type.new Lib.get_array_element_type(@type), @translation_unit
+			end
+
+			def array_size
+				Lib.get_array_size(@type)
+			end
+
+			def alignof
+				Lib.type_get_align_of(@type)
+			end
+
+			def sizeof
+				Lib.type_get_size_of(@type)
+			end
+
+			def offsetof(field)
+				Lib.type_get_offset_of(@type, field)
+			end
+
+			def ref_qualifier
+				Lib.type_get_cxx_ref_qualifier(@type)
+			end
+
+			def calling_conv
+				Lib.get_fuction_type_calling_conv(@type)
+			end
+
+			def declaration
+				Cursor.new Lib.get_type_declaration(@type), @translation_unit
+			end
+
+			def ==(other)
+				Lib.equal_types(@type, other.type) != 0
+			end
 		end
 	end
 end

data/lib/ffi/clang/unsaved_file.rb

@@ -28,6 +28,22 @@ module FFI
 			end
 
 			attr_accessor :filename, :contents
+
+
+			def self.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/utils.rb

@@ -1,4 +1,5 @@
 # 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
@@ -23,35 +24,60 @@ require 'ffi/clang/lib/string'
 
 module FFI
 	module Clang
-		class Utils
+		module Utils
+			@@clang_version = nil
+			
 			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
+				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 5.0 (clang-500.2.79) (based on LLVM 3.3svn)"
+					# Linux: "clang version 3.3"
+				
+					if 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 "Clang version detected: #{@@clang_version.inspect}"
+					else
+						abort "Invalid/unsupported clang version string."
+					end
+				end
+				
+				return @@clang_version
 			end
 
 			def self.clang_version_symbol
-				version = "clang_" + clang_version.tr('.', '_')
-				version.intern
+				"clang_#{clang_version.join('_')}".to_sym
 			end
 
 			def self.clang_major_version
-				version = clang_version_string
-				version.match(/clang version (\d+)\./).values_at(1).first.to_i
+				clang_version[0]
 			end
 
 			def self.clang_minor_version
-				version = clang_version_string
-				version.match(/clang version \d+\.(\d+)/).values_at(1).first.to_i
+				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)
-				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))
+				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