ffi-clang 0.2.0 → 0.2.1

data/lib/ffi/clang/compilation_database.rb

@@ -0,0 +1,125 @@
+# 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/compilation_database'
+
+module FFI
+	module Clang
+		class CompilationDatabase < AutoPointer
+			class DatabaseLoadError < FFI::Clang::Error; end
+
+			def initialize(dirpath)
+				uint_ptr = MemoryPointer.new :uint
+				cdb_ptr = Lib.compilation_database_from_directory(dirpath, uint_ptr)
+				error_code = Lib::CompilationDatabaseError[uint_ptr.read_uint]
+				if error_code != :no_error
+					raise DatabaseLoadError, "Cannot load database: #{error_code}"
+				end
+				super cdb_ptr
+			end
+
+			def self.release(pointer)
+				Lib.compilation_database_dispose(pointer)
+			end
+
+			def compile_commands(filename)
+				CompileCommands.new Lib.compilation_database_get_compile_commands(self, filename), self
+			end
+
+			def all_compile_commands
+				CompileCommands.new Lib.compilation_database_get_all_compile_commands(self), self
+			end
+
+			class CompileCommands < AutoPointer
+				include Enumerable
+
+				def initialize(pointer, database)
+					super pointer
+					@database = database
+				end
+
+				def self.release(pointer)
+					Lib.compile_commands_dispose(pointer)
+				end
+
+				def size
+					Lib.compile_commands_get_size(self)
+				end
+
+				def command(i)
+					CompileCommand.new Lib.compile_commands_get_command(self, i)
+				end
+
+				def commands
+					size.times.map { |i| command(i) }
+				end
+
+				def each(&block)
+					size.times.map do |i|
+						block.call(command(i))
+					end
+				end
+			end
+
+			class CompileCommand
+				def initialize(pointer)
+					@pointer = pointer
+				end
+
+				def directory
+					Lib.extract_string Lib.compile_command_get_directory(@pointer)
+				end
+
+				def num_args
+					Lib.compile_command_get_num_args(@pointer)
+				end
+
+				def arg(i)
+					Lib.extract_string Lib.compile_command_get_arg(@pointer, i)
+				end
+
+				def args
+					num_args.times.map { |i| arg(i) }
+				end
+
+				def num_mapped_sources
+					raise NotImplementedError
+					# Lib.compile_command_get_num_mapped_sources(@pointer)
+				end
+
+				def mapped_source_path(i)
+					raise NotImplementedError
+					# Lib.extract_string Lib.compile_command_get_mapped_source_path(@pointer, i)
+				end
+
+				def mapped_source_content(i)
+					raise NotImplementedError
+					# Lib.extract_string Lib.compile_command_get_mapped_source_content(@pointer, i)
+				end
+
+				def mapped_sources
+					num_mapped_sources.times.map { |i|
+						{path: mapped_source_path(i), content: mapped_source_content(i)}
+					}
+				end
+			end
+		end
+	end
+end

data/lib/ffi/clang/cursor.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
@@ -23,6 +24,7 @@ require 'ffi/clang/lib/cursor'
 require 'ffi/clang/source_location'
 require 'ffi/clang/comment'
 require 'ffi/clang/type'
+require 'ffi/clang/lib/code_completion'
 
 module FFI
 	module Clang
@@ -34,6 +36,11 @@ module FFI
 				Cursor.new Lib.get_null_cursor, nil
 			end
 
+			# this function is categorized as "Debugging facilities"
+			def self.kind_spelling(kind)
+				Lib.extract_string Lib.get_cursor_kind_spelling(kind)
+			end
+
 			def initialize(cxcursor, translation_unit)
 				@cursor = cxcursor
 				@translation_unit = translation_unit
@@ -51,6 +58,14 @@ module FFI
 				Comment.build_from Lib.cursor_get_parsed_comment(@cursor)
 			end
 
+			def comment_range
+				SourceRange.new(Lib.cursor_get_comment_range(@cursor))
+			end
+
+			def completion
+				CodeCompletion::String.new Lib.get_cursor_completion_string(@cursor)
+			end
+
 			def declaration?
 				Lib.is_declaration(kind) != 0
 			end
@@ -100,7 +115,7 @@ module FFI
 			end
 
 			def location
-				SourceLocation.new(Lib.get_cursor_location(@cursor))
+				ExpansionLocation.new(Lib.get_cursor_location(@cursor))
 			end
 
 			def extent
@@ -123,6 +138,10 @@ module FFI
 				@cursor[:kind]
 			end
 
+			def kind_spelling
+				Cursor.kind_spelling @cursor[:kind]
+			end
+
 			def type
 				Type.new Lib.get_cursor_type(@cursor), @translation_unit
 			end
@@ -136,7 +155,7 @@ module FFI
 			end
 
 			def enum_decl_integer_type
-				Type.new Lib.get_decl_integer_type(@cursor), @translation_unit
+				Type.new Lib.get_enum_decl_integer_type(@cursor), @translation_unit
 			end
 
 			def virtual_base?
@@ -171,6 +190,10 @@ module FFI
 				Lib.get_enum_value @cursor
 			end
 
+			def enum_unsigned_value
+				Lib.get_enum_unsigned_value @cursor
+			end
+
 			def specialized_template
 				Cursor.new Lib.get_specialized_cursor_template(@cursor), @translation_unit
 			end
@@ -207,6 +230,10 @@ module FFI
 				Lib.get_language @cursor
 			end
 
+			def translation_unit
+				@translation_unit
+			end
+
 			def visit_children(&block)
 				adapter = Proc.new do |cxcursor, parent_cursor, unused|
 					block.call Cursor.new(cxcursor, @translation_unit), Cursor.new(parent_cursor, @translation_unit)
@@ -224,24 +251,133 @@ module FFI
 			end
 
 			def included_file
-				raise NotImplementedError
+				File.new Lib.get_included_file(@cursor), @translation_unit
+			end
+
+			def platform_availability(max_availability_size = 4)
+				availability_ptr = FFI::MemoryPointer.new(Lib::CXPlatformAvailability, max_availability_size)
+				always_deprecated_ptr = FFI::MemoryPointer.new :int
+				always_unavailable_ptr = FFI::MemoryPointer.new :int
+				deprecated_message_ptr = FFI::MemoryPointer.new Lib::CXString
+				unavailable_message_ptr = FFI::MemoryPointer.new Lib::CXString
+
+				actual_availability_size = Lib.get_cursor_platform_availability(
+					@cursor,
+					always_deprecated_ptr, deprecated_message_ptr,
+					always_unavailable_ptr, unavailable_message_ptr,
+					availability_ptr, max_availability_size)
+
+				availability = []
+				cur_ptr = availability_ptr
+				[actual_availability_size, max_availability_size].min.times {
+					availability << PlatformAvailability.new(cur_ptr)
+					cur_ptr += Lib::CXPlatformAvailability.size
+				}
+
+				# return as Hash
+				{
+					always_deprecated: always_deprecated_ptr.get_int(0),
+					always_unavailable: always_unavailable_ptr.get_int(0),
+					deprecated_message: Lib.extract_string(Lib::CXString.new(deprecated_message_ptr)),
+					unavailable_message: Lib.extract_string(Lib::CXString.new(unavailable_message_ptr)),
+					availability: availability
+				}
+			end
+
+			def overriddens
+				cursor_ptr = FFI::MemoryPointer.new :pointer
+				num_ptr = FFI::MemoryPointer.new :uint
+				Lib.get_overridden_cursors(@cursor, cursor_ptr, num_ptr)
+				num = num_ptr.get_uint(0)
+				cur_ptr = cursor_ptr.get_pointer(0)
+
+				overriddens = []
+				num.times {
+					overriddens << Cursor.new(cur_ptr, @translation_unit)
+					cur_ptr += Lib::CXCursor.size
+				}
+				Lib.dispose_overridden_cursors(cursor_ptr.get_pointer(0)) if num != 0
+				overriddens
 			end
 
-			def platform_availability
-				raise NotImplementedError
+			def hash
+				Lib.get_cursor_hash(@cursor)
 			end
 
-			def get_overridden_cursors
-				raise NotImplementedError
+			def bitfield?
+				Lib.is_bit_field(@cursor) != 0
 			end
 
-			def hash
-				Lib.get_cursor_hash(@cursor)
+			def bitwidth
+				Lib.get_field_decl_bit_width(@cursor)
+			end
+
+			def overloaded_decl(i)
+				Cursor.new Lib.get_overloaded_decl(@cursor, i), @translation_unit
+			end
+
+			def num_overloaded_decls
+				Lib.get_num_overloaded_decls(@cursor)
+			end
+
+			def objc_type_encoding
+				Lib.extract_string Lib.get_decl_objc_type_encoding(@cursor)
+			end
+
+			def argument(i)
+				Cursor.new Lib.cursor_get_argument(@cursor, i), @translation_unit
+			end
+
+			def num_arguments
+				Lib.cursor_get_num_arguments(@cursor)
 			end
 
+			attr_reader :cursor
+
 			def ==(other)
 				Lib.are_equal(@cursor, other.cursor) != 0
 			end
+
+			class PlatformAvailability < AutoPointer
+				def initialize(memory_pointer)
+					pointer = FFI::Pointer.new(memory_pointer)
+					super(pointer)
+
+					# I'm not sure this is safe.
+					# Keep a reference to CXPlatformAvailability itself allocated by MemoryPointer.
+					@memory_pointer = memory_pointer
+					@platform_availability = Lib::CXPlatformAvailability.new(memory_pointer)
+				end
+
+				def self.release(pointer)
+					# Memory allocated by get_cursor_platform_availability is managed by AutoPointer.
+					Lib.dispose_platform_availability(Lib::CXPlatformAvailability.new(pointer))
+				end
+
+				def platform
+					Lib.get_string @platform_availability[:platform]
+				end
+
+				def introduced
+					@platform_availability[:introduced]
+				end
+
+				def deprecated
+					@platform_availability[:deprecated]
+				end
+
+				def obsoleted
+					@platform_availability[:obsoleted]
+				end
+
+				def unavailable
+					@platform_availability[:unavailable] != 0
+				end
+
+				def message
+					Lib.get_string @platform_availability[:message]
+				end
+			end
 		end
 	end
 end

data/lib/ffi/clang/diagnostic.rb

@@ -26,6 +26,10 @@ require 'ffi/clang/source_range'
 module FFI
 	module Clang
 		class Diagnostic < AutoPointer
+			def self.default_display_opts
+				Lib.opts_from Lib::DiagnosticDisplayOptions, Lib.default_diagnostic_display_options
+			end
+
 			def initialize(translation_unit, pointer)
 				super pointer
 
@@ -51,15 +55,16 @@ module FFI
 
 			def location
 				sl = Lib.get_diagnostic_location(self)
-				SourceLocation.new sl
+				ExpansionLocation.new sl
 			end
 
 			def fixits
-				raise NotImplementedError
-				# unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diag);
-				# – CXString clang_getDiagnosticFixIt(CXDiagnostic Diag,
-				#                                     unsigned FixIt,
-				#                                     CXSourceRange *ReplacementRange);
+				n = Lib.get_diagnostic_num_fix_its(self)
+				n.times.map { |i|
+				ptr = MemoryPointer.new Lib::CXSourceRange
+					replace_text = Lib.extract_string(Lib.get_diagnostic_fix_it(self, i, ptr))
+					{text: replace_text, range: SourceRange.new(ptr)}
+				}
 			end
 
 			def ranges
@@ -68,12 +73,34 @@ module FFI
 				n.times.map {|i| SourceRange.new Lib.get_diagnostic_range(self, i)}
 			end
 
-			private
+			def children
+				diagnostic_set = Lib.get_child_diagnostics(self)
+				num_diagnostics = Lib.get_num_diagnostics_in_set(diagnostic_set)
+				num_diagnostics.times.map { |i|
+					Diagnostic.new(@translation_unit, Lib.get_diagnostic_in_set(diagnostic_set, i))
+				}
+			end
 
-			def range_count
-				
+			def enable_option
+				Lib.extract_string Lib.get_diagnostic_option(self, nil)
+			end
+
+			def disable_option
+				ptr = MemoryPointer.new Lib::CXString
+				Lib.get_diagnostic_option(self, ptr)
+				Lib.extract_string ptr
 			end
 
+			def category
+				Lib.extract_string Lib.get_diagnostic_category_text(self)
+			end
+
+			def category_id
+				Lib.get_diagnostic_category(self)
+			end
+
+			private
+
 			def display_opts(opts)
 				if opts.empty?
 					Lib.default_diagnostic_display_options
@@ -81,7 +108,6 @@ module FFI
 					Lib.bitmask_from Lib::DiagnosticDisplayOptions, opts
 				end
 			end
-
 		end
 	end
 end

data/lib/ffi/clang/file.rb

@@ -0,0 +1,69 @@
+# 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/file'
+require 'ffi/clang/utils'
+
+module FFI
+	module Clang
+		class File < Pointer
+			attr_reader :translation_unit
+
+			def initialize(pointer, tu)
+				super pointer
+				@translation_unit = tu
+
+				if FFI::Clang::Utils.satisfy_version?('3.3')
+					pointer = MemoryPointer.new(Lib::CXFileUniqueID)
+					Lib.get_file_unique_id(self, pointer)
+					@unique_id = Lib::CXFileUniqueID.new(pointer)
+				end
+			end
+
+			def to_s
+				name
+			end
+
+			def name
+				Lib.extract_string Lib.get_file_name(self)
+			end
+
+			def time
+				Time.at(Lib.get_file_time(self))
+			end
+
+			def include_guarded?
+				Lib.is_file_multiple_include_guarded(@translation_unit, self) != 0
+			end
+
+			def device
+				@unique_id[:device]
+			end
+
+			def inode
+				@unique_id[:inode]
+			end
+
+			def modification
+				Time.at(@unique_id[:modification])
+			end
+		end
+	end
+end