ffi-clang 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0711385ae78d16e56e06a6bb827a08951c1128dd
-  data.tar.gz: 5eb03fd538e2949c1063a07c071ab778e000b7cb
+  metadata.gz: ba2f1301bc825e8bb4bfe80ebe60ed2e2b20945a
+  data.tar.gz: 4d33834e8851dfcf646cb934dfd5a0921f5d81e8
 SHA512:
-  metadata.gz: 95fe823fc29639734c09302303b96c92a50060c0a5ac09adc9936f3d7b37ade0d90a6bf878eaf4bf4415f5a22f20807e086de7b0e8a242bd00cfa2f12edbde73
-  data.tar.gz: 54e2bfa618b2eeff3b0920ea731f9e3391179c761fce11c1a86ede8f1b40894d0770a3ece965942680ab4f0985e61501b1bb9d903a08d761d46eda0de010aece
+  metadata.gz: 93f851368ed6a50978407ab7227511d7a20fd12716cb6413615ab00b015867b384c8c3b8eb7e1921a3ddb2b95321202282dafc8a854459342f9243c4e66774ef
+  data.tar.gz: 365b47a6501012f6498fdbc3c9754ca4b9a2226edd5853f4084b93ac552c97a82a9c440d0fce1eb6e6f00bdd9115d144b265a78973971feb8e6cb49f85ac3d41

data/.travis.yml

@@ -8,11 +8,15 @@ env:
   - LLVM_VERSION=3.4
   - LLVM_VERSION=3.5
 install:
-    - sudo add-apt-repository --yes ppa:h-rayflood/llvm
-    - sudo add-apt-repository --yes ppa:ubuntu-toolchain-r/test
-    - sudo add-apt-repository --yes 'deb http://llvm.org/apt/precise/ llvm-toolchain-precise main'
-    - wget -O - http://llvm.org/apt/llvm-snapshot.gpg.key | sudo apt-key add -
-    - sudo apt-get -qq update
-    - sudo apt-get -qq install libclang-${LLVM_VERSION}-dev
-    - export LD_LIBRARY_PATH=/usr/lib/llvm-${LLVM_VERSION}/lib/
-    - bundle install
+  - sudo add-apt-repository --yes ppa:h-rayflood/llvm
+  - sudo add-apt-repository --yes ppa:ubuntu-toolchain-r/test
+  - sudo add-apt-repository --yes 'deb http://llvm.org/apt/precise/ llvm-toolchain-precise main'
+  - wget -O - http://llvm.org/apt/llvm-snapshot.gpg.key | sudo apt-key add -
+  - sudo apt-get -qq update
+  - sudo apt-get -qq install libclang-${LLVM_VERSION}-dev clang-${LLVM_VERSION}
+  - export LD_LIBRARY_PATH=/usr/lib/llvm-${LLVM_VERSION}/lib/
+  - export PATH=/usr/lib/llvm-${LLVM_VERSION}/bin:$PATH
+  - bundle install
+matrix:
+  allow_failures:
+    - env: LLVM_VERSION=3.5

data/README.md

@@ -1,10 +1,12 @@
 # FFI::Clang
 
-A light weight wrapper for Ruby exposing libclang.
+A light weight wrapper for Ruby exposing [libclang][1].
 
 [![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)
 
+[1]: http://llvm.org/devmtg/2010-11/Gregor-libclang.pdf
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/ffi-clang.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
 	spec.add_dependency "ffi"
 
 	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rspec", "~> 3.0.0"
 	spec.add_development_dependency "rake"
-	spec.add_development_dependency "rspec"
 end

data/lib/ffi/clang.rb

@@ -51,4 +51,6 @@ require 'ffi/clang/cursor'
 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,193 @@
+# 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
+
+				def inspect
+					@results.inspect
+				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
+
+				def inspect
+					"<#{kind.inspect} = #{string.inspect}>"
+				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
+
+				def inspect
+					chunks.inspect
+				end
+			end
+		end
+	end
+end

data/lib/ffi/clang/comment.rb

@@ -32,23 +32,41 @@ module FFI
 			def self.build_from(comment)
 				kind = Lib.comment_get_kind(comment)
 				case kind
-				when :comment_full
-					FullComment.new comment
-				when :comment_paragraph
-					ParagraphComment.new comment
+				when :comment_null
+					Comment.new comment
 				when :comment_text
 					TextComment.new comment
+				when :comment_inline_command
+					InlineCommandComment.new comment
+				when :comment_html_start_tag
+					HTMLStartTagComment.new comment
+				when :comment_html_end_tag
+					HTMLEndTagComment.new comment
+				when :comment_paragraph
+					ParagraphComment.new comment
 				when :comment_block_command
 					BlockCommandComment.new comment
 				when :comment_param_command
 					ParamCommandComment.new comment
-				when :comment_null
-					Comment.new comment
+				when :comment_tparam_command
+					TParamCommandComment.new comment
+				when :comment_verbatim_block_command
+					VerbatimBlockCommandComment.new comment
+				when :comment_verbatim_block_line
+					VerbatimBlockLineComment.new comment
+				when :comment_verbatim_line
+					VerbatimLine.new comment
+				when :comment_full
+					FullComment.new comment
 				else
 					raise NotImplementedError, kind
 				end
 			end
 
+			def text
+				return ""
+			end
+
 			def initialize(comment)
 				@comment = comment
 			end
@@ -65,14 +83,59 @@ module FFI
 				Comment.build_from Lib.comment_get_child(@comment, n)
 			end
 
+			def children
+				num_children.times.map { |i| child(i) }
+			end
+
+			def whitespace?
+				Lib.comment_is_whitespace(@comment) != 0
+			end
+
+			def has_trailing_newline?
+				Lib.inline_content_comment_has_trailing_newline(@comment) != 0
+			end
+
 			def each(&block)
-				(0..num_children-1).map do |i|
+				num_children.times.map do |i|
 					block.call(child(i))
 				end
 			end
 
 		end
 
+		class HTMLTagComment < Comment
+			def name
+				Lib.extract_string Lib.html_tag_comment_get_tag_name(@comment)
+			end
+			alias_method :tag, :name
+
+			def text
+				Lib.extract_string Lib.html_tag_comment_get_as_string(@comment)
+			end
+		end
+
+		class HTMLStartTagComment < HTMLTagComment
+			def self_closing?
+				Lib.html_start_tag_comment_is_self_closing(@comment) != 0
+			end
+
+			def num_attrs
+				Lib.html_start_tag_comment_get_num_attrs(@comment)
+			end
+
+			def attrs
+				num_attrs.times.map { |i|
+					{
+						name: Lib.extract_string(Lib.html_start_tag_comment_get_attr_name(@comment, i)),
+						value: Lib.extract_string(Lib.html_start_tag_comment_get_attr_value(@comment, i)),
+					}
+			  }
+			end
+		end
+
+		class HTMLEndTagComment < HTMLTagComment
+		end
+
 		class ParagraphComment < Comment
 			def text
 				self.map(&:text).join("\n")
@@ -85,6 +148,30 @@ module FFI
 			end
 		end
 
+		class InlineCommandComment < Comment
+			def name
+				Lib.extract_string Lib.inline_command_comment_get_command_name(@comment)
+			end
+
+			def render_kind
+				Lib.inline_command_comment_get_render_kind(@comment)
+			end
+
+			def num_args
+				Lib.inline_command_comment_get_num_args(@comment)
+			end
+
+			def args
+				num_args.times.map { |i|
+					Lib.extract_string Lib.inline_command_comment_get_arg_text(@comment, i)
+				}
+			end
+
+			def text
+				args.join
+			end
+		end
+
 		class BlockCommandComment < Comment
 			def name
 				Lib.extract_string Lib.block_command_comment_get_command_name(@comment)
@@ -94,13 +181,20 @@ module FFI
 				Comment.build_from Lib.block_command_comment_get_paragraph(@comment)
 			end
 
-			def comment
+			def text
 				self.paragraph.text
 			end
+			alias_method :comment, :text
 
 			def num_args
 				Lib.block_command_comment_get_num_args(@comment)
 			end
+
+			def args
+				num_args.times.map { |i|
+					Lib.extract_string Lib.block_command_comment_get_arg_text(@comment, i)
+				}
+			end
 		end
 
 		class ParamCommandComment < Comment
@@ -108,9 +202,10 @@ module FFI
 				Lib.extract_string Lib.param_command_comment_get_param_name(@comment)
 			end
 
-			def comment
-				self.child.text
+			def text
+				self.map(&:text).join("")
 			end
+			alias_method :comment, :text
 
 			def valid_index?
 				Lib.param_command_comment_is_param_index_valid(@comment) != 0
@@ -119,6 +214,55 @@ module FFI
 			def index
 				Lib.param_command_comment_get_param_index(@comment)
 			end
+
+			def direction_explicit?
+				Lib.param_command_comment_is_direction_explicit(@comment) != 0
+			end
+
+			def direction
+				Lib.param_command_comment_get_direction(@comment)
+			end
+		end
+
+		class TParamCommandComment < Comment
+			def text
+				self.child.text
+			end
+			alias_method :comment, :text
+
+			def name
+				Lib.extract_string Lib.tparam_command_comment_get_param_name(@comment)
+			end
+
+			def valid_position?
+				Lib.tparam_command_comment_is_param_position_valid(@comment) != 0
+			end
+
+			def depth
+				Lib.tparam_command_comment_get_depth(@comment)
+			end
+
+			def index(depth = 0)
+				Lib.tparam_command_comment_get_index(@comment, depth)
+			end
+		end
+
+		class VerbatimBlockCommandComment < Comment
+			def text
+				children.map(&:text).join("\n")
+			end
+		end
+
+		class VerbatimBlockLineComment < Comment
+			def text
+				Lib.extract_string Lib.verbatim_block_line_comment_get_text(@comment)
+			end
+		end
+
+		class VerbatimLine < Comment
+			def text
+				Lib.extract_string Lib.verbatim_line_comment_get_text(@comment)
+			end
 		end
 
 		class FullComment < Comment
@@ -130,6 +274,5 @@ module FFI
 				Lib.extract_string Lib.full_comment_get_as_xml(@comment)
 			end
 		end
-
 	end
 end