ghazel-ffi-clang 0.2.0.2 → 0.2.1

data/lib/ffi/clang.rb

@@ -52,3 +52,5 @@ require 'ffi/clang/source_location'
 require 'ffi/clang/source_range'
 require 'ffi/clang/unsaved_file'
 require 'ffi/clang/token'
+require 'ffi/clang/code_completion'
+require 'ffi/clang/compilation_database'

data/lib/ffi/clang/code_completion.rb

@@ -0,0 +1,181 @@
+# 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/code_completion'
+
+module FFI
+	module Clang
+		class CodeCompletion
+			def self.default_code_completion_options
+				Lib.opts_from Lib::CodeCompleteFlags, Lib.default_code_completion_options
+			end
+
+			class Results < FFI::AutoPointer
+				include Enumerable
+
+				attr_reader :size
+				attr_reader :results
+
+				def initialize(code_complete_results, translation_unit)
+					super code_complete_results.pointer
+					@translation_unit = translation_unit
+					@code_complete_results = code_complete_results
+					initialize_results
+				end
+
+				def self.release(pointer)
+					Lib.dispose_code_complete_results(pointer)
+				end
+
+				def each(&block)
+					@results.each do |token|
+						block.call(token)
+					end
+				end
+
+				def num_diagnostics
+					Lib.get_code_complete_get_num_diagnostics(@code_complete_results)
+				end
+
+				def diagnostic(i)
+					Diagnostic.new(@translation_unit, Lib.get_code_complete_get_diagnostic(@code_complete_results, i))
+				end
+
+				def diagnostics
+					num_diagnostics.times.map { |i|
+						Diagnostic.new(@translation_unit, Lib.get_code_complete_get_diagnostic(@code_complete_results, i))
+					}
+				end
+
+				def contexts
+					Lib.opts_from Lib::CompletionContext, Lib.get_code_complete_get_contexts(@code_complete_results)
+				end
+
+				def container_usr
+					Lib.extract_string Lib.get_code_complete_get_container_usr(@code_complete_results)
+				end
+
+				def container_kind
+					is_incomplete = MemoryPointer.new :uint
+					Lib.get_code_complete_get_container_kind(@code_complete_results, is_incomplete)
+				end
+
+				def incomplete?
+					is_incomplete = MemoryPointer.new :uint
+					Lib.get_code_complete_get_container_kind(@code_complete_results, is_incomplete)
+					is_incomplete.read_uint != 0
+				end
+
+				def objc_selector
+					Lib.extract_string Lib.get_code_complete_get_objc_selector(@code_complete_results)
+				end
+
+				def sort!
+					Lib.sort_code_completion_results(@code_complete_results[:results], @code_complete_results[:num])
+					initialize_results
+				end
+
+				private
+
+				def initialize_results
+					@size = @code_complete_results[:num]
+					cur_ptr = @code_complete_results[:results]
+					@results = []
+					@size.times {
+						@results << Result.new(Lib::CXCompletionResult.new(cur_ptr))
+						cur_ptr += Lib::CXCompletionResult.size
+					}
+				end
+			end
+
+			class Result
+				def initialize(result)
+					@result = result
+				end
+
+				def kind
+					@result[:kind]
+				end
+
+				def string
+					CodeCompletion::String.new @result[:string]
+				end
+			end
+
+			class String
+				def initialize(ptr)
+					@pointer = ptr
+				end
+
+				def chunk_kind(i)
+					Lib.get_completion_chunk_kind(@pointer, i)
+				end
+
+				def chunk_text(i)
+					Lib.extract_string Lib.get_completion_text(@pointer, i)
+				end
+
+				def chunk_completion(i)
+					CodeCompletion::String.new Lib.get_completion_chunk_completion_string(@pointer, i)
+				end
+
+				def num_chunks
+					Lib.get_num_completion_chunks(@pointer)
+				end
+
+				def chunks
+					num_chunks.times.map { |i|
+						{ kind: chunk_kind(i), text: chunk_text(i), completion: chunk_completion(i) }
+					}
+				end
+
+				def priority
+					Lib.get_completion_priority(@pointer)
+				end
+
+				def availability
+					Lib.get_completion_availability(@pointer)
+				end
+
+				def num_annotations
+					Lib.get_completion_num_annotations(@pointer)
+				end
+
+				def annotation(i)
+					Lib.extract_string Lib.get_completion_annotation(@pointer, i)
+				end
+
+				def annotations
+					num_annotations.times.map { |i|
+						Lib.extract_string Lib.get_completion_annotation(@pointer, i)
+					}
+				end
+
+				def parent
+					Lib.extract_string Lib.get_completion_parent(@pointer, nil)
+				end
+
+				def comment
+					Lib.extract_string Lib.get_completion_brief_comment(@pointer)
+				end
+			end
+		end
+	end
+end

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

@@ -24,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
@@ -61,6 +62,10 @@ module FFI
 				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

data/lib/ffi/clang/lib.rb

@@ -31,7 +31,11 @@ module FFI
 			elsif ENV['LLVM_CONFIG']
 				llvm_library_dir = `#{ENV['LLVM_CONFIG']} --libdir`.chomp
 
-				libs << llvm_library_dir + '/libclang.dylib'
+				if FFI::Clang.platform == :darwin
+					libs << llvm_library_dir + '/libclang.dylib'
+				else
+					libs << llvm_library_dir + '/libclang.so'
+				end
 			end
 
 			ffi_lib libs

data/lib/ffi/clang/lib/code_completion.rb

@@ -0,0 +1,130 @@
+# 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/translation_unit'
+require 'ffi/clang/lib/cursor'
+require 'ffi/clang/lib/diagnostic'
+
+module FFI
+	module Clang
+		module Lib
+			typedef :pointer, :CXCompletionString
+
+			class CXCompletionResult < FFI::Struct
+				layout(
+					:kind, :cursor_kind,
+					:string, :CXCompletionString,
+				)
+			end
+
+			class CXCodeCompleteResults < FFI::Struct
+				layout(
+					:results, :pointer,
+					:num, :uint,
+				)
+			end
+
+			enum :completion_chunk_kind, [
+				:optional,
+				:typed_text,
+				:text,
+				:placeholder,
+				:informative,
+				:current_parameter,
+				:left_paren,
+				:right_paren,
+				:left_bracket,
+				:right_bracket,
+				:left_brace,
+				:right_brace,
+				:left_angle,
+				:right_angle,
+				:comma,
+				:result_type,
+				:colon,
+				:semi_colon,
+				:equal,
+				:horizontal_space,
+				:vertical_space
+			]
+
+			CodeCompleteFlags = enum :code_complete_flags, [
+				:include_macros, 0x01,
+				:include_code_patterns, 0x02,
+				:include_brief_comments, 0x04
+			]
+
+			CompletionContext = enum :completion_context, [
+				:unexposed, 0,
+				:any_type, 1 << 0,
+				:any_value, 1 << 1,
+				:objc_object_value, 1 << 2,
+				:objc_selector_value, 1 << 3,
+				:cxx_class_type_value, 1 << 4,
+				:dot_member_access, 1 << 5,
+				:arrow_member_access, 1 << 6,
+				:objc_property_access, 1 << 7,
+				:enum_tag, 1 << 8,
+				:union_tag, 1 << 9,
+				:struct_tag, 1 << 10,
+				:class_tag, 1 << 11,
+				:namespace, 1 << 12,
+				:nested_name_specifier, 1 << 13,
+				:objc_interface, 1 << 14,
+				:objc_protocol, 1 << 15,
+				:objc_category, 1 << 16,
+				:objc_instance_message, 1 << 17,
+				:objc_class_message, 1 << 18,
+				:objc_selector_name, 1 << 19,
+				:macro_name, 1 << 20,
+				:natural_language, 1 << 21,
+				:unknown, ((1 << 22) - 1),
+			]
+
+			# CXCompletionString functions
+			attach_function :get_completion_chunk_kind, :clang_getCompletionChunkKind, [:CXCompletionString, :uint], :completion_chunk_kind
+			attach_function :get_completion_text, :clang_getCompletionChunkText, [:CXCompletionString, :uint], CXString.by_value
+			attach_function :get_completion_chunk_completion_string, :clang_getCompletionChunkCompletionString, [:CXCompletionString, :uint], :CXCompletionString
+			attach_function :get_num_completion_chunks, :clang_getNumCompletionChunks, [:CXCompletionString], :uint
+			attach_function :get_completion_priority, :clang_getCompletionPriority, [:CXCompletionString], :uint
+			attach_function :get_completion_availability, :clang_getCompletionAvailability, [:CXCompletionString], :availability
+			attach_function :get_completion_num_annotations, :clang_getCompletionNumAnnotations, [:CXCompletionString], :uint
+			attach_function :get_completion_annotation, :clang_getCompletionAnnotation, [:CXCompletionString, :uint], CXString.by_value
+			attach_function :get_completion_parent, :clang_getCompletionParent, [:CXCompletionString, :pointer], CXString.by_value
+			attach_function :get_completion_brief_comment, :clang_getCompletionBriefComment, [:CXCompletionString], CXString.by_value
+
+			# CXCodeCompleteResults functions
+			attach_function :get_code_complete_get_num_diagnostics, :clang_codeCompleteGetNumDiagnostics, [CXCodeCompleteResults.ptr], :uint
+			attach_function :get_code_complete_get_diagnostic, :clang_codeCompleteGetDiagnostic, [CXCodeCompleteResults.ptr, :uint], :CXDiagnostic
+			attach_function :get_code_complete_get_contexts, :clang_codeCompleteGetContexts, [CXCodeCompleteResults.ptr], :ulong_long
+			attach_function :get_code_complete_get_container_kind, :clang_codeCompleteGetContainerKind, [CXCodeCompleteResults.ptr, :pointer], :cursor_kind
+			attach_function :get_code_complete_get_container_usr, :clang_codeCompleteGetContainerUSR, [CXCodeCompleteResults.ptr], CXString.by_value
+			attach_function :get_code_complete_get_objc_selector, :clang_codeCompleteGetObjCSelector, [CXCodeCompleteResults.ptr], CXString.by_value
+
+			# Other functions
+			attach_function :code_complete_at, :clang_codeCompleteAt, [:CXTranslationUnit, :string, :uint, :uint, :pointer, :uint, :uint], CXCodeCompleteResults.ptr
+			attach_function :dispose_code_complete_results, :clang_disposeCodeCompleteResults, [CXCodeCompleteResults.ptr], :void
+			attach_function :get_cursor_completion_string, :clang_getCursorCompletionString, [CXCursor.by_value], :CXCompletionString
+			attach_function :default_code_completion_options, :clang_defaultCodeCompleteOptions, [], :uint
+			attach_function :sort_code_completion_results, :clang_sortCodeCompletionResults, [:pointer, :uint], :void
+		end
+	end
+end
+