ghazel-ffi-clang 0.2.0.1

data/lib/ffi/clang/cursor.rb

@@ -0,0 +1,378 @@
+# 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
+# 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'
+require 'ffi/clang/comment'
+require 'ffi/clang/type'
+
+module FFI
+	module Clang
+		class Cursor
+			attr_reader :cursor
+			attr_reader :translation_unit
+
+			def self.null_cursor
+				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
+			end
+
+			def null?
+				Lib.cursor_is_null(@cursor) != 0
+			end
+
+			def raw_comment_text
+				Lib.extract_string Lib.cursor_get_raw_comment_text(@cursor)
+			end
+
+			def comment
+				Comment.build_from Lib.cursor_get_parsed_comment(@cursor)
+			end
+
+			def comment_range
+				SourceRange.new(Lib.cursor_get_comment_range(@cursor))
+			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 public?
+				Lib.cxx_get_access_specifier(@cursor) == :public
+			end
+
+			def private?
+				Lib.cxx_get_access_specifier(@cursor) == :private
+			end
+
+			def protected?
+				Lib.cxx_get_access_specifier(@cursor) == :protected
+			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
+				ExpansionLocation.new(Lib.get_cursor_location(@cursor))
+			end
+
+			def extent
+				SourceRange.new(Lib.get_cursor_extent(@cursor))
+			end
+
+			def display_name
+				Lib.extract_string Lib.get_cursor_display_name(@cursor)
+			end
+
+			def spelling
+				Lib.extract_string Lib.get_cursor_spelling(@cursor)
+			end
+
+			def usr
+				Lib.extract_string Lib.get_cursor_usr(@cursor)
+			end
+
+			def kind
+				@cursor[:kind]
+			end
+
+			def kind_spelling
+				Cursor.kind_spelling @cursor[:kind]
+			end
+
+			def type
+				Type.new Lib.get_cursor_type(@cursor), @translation_unit
+			end
+
+			def result_type
+				Type.new Lib.get_cursor_result_type(@cursor), @translation_unit
+			end
+
+			def underlying_type
+				Type.new Lib.get_typedef_decl_underlying_type(@cursor), @translation_unit
+			end
+
+			def enum_decl_integer_type
+				Type.new Lib.get_enum_decl_integer_type(@cursor), @translation_unit
+			end
+
+			def virtual_base?
+				Lib.is_virtual_base(@cursor) != 0
+			end
+
+			def dynamic_call?
+				Lib.is_dynamic_call(@cursor) != 0
+			end
+
+			def variadic?
+				Lib.is_variadic(@cursor) != 0
+			end
+
+			def definition?
+				Lib.is_definition(@cursor) != 0
+			end
+
+			def static?
+				Lib.cxx_method_is_static(@cursor) != 0
+			end
+
+			def virtual?
+				Lib.cxx_method_is_virtual(@cursor) != 0
+			end
+
+			def pure_virtual?
+				Lib.cxx_method_is_pure_virtual(@cursor) != 0
+			end
+
+			def enum_value
+				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
+
+			def canonical
+				Cursor.new Lib.get_canonical_cursor(@cursor), @translation_unit
+			end
+
+			def definition
+				Cursor.new Lib.get_cursor_definition(@cursor), @translation_unit
+			end
+
+			def referenced
+				Cursor.new Lib.get_cursor_referenced(@cursor), @translation_unit
+			end
+
+			def semantic_parent
+				Cursor.new Lib.get_cursor_semantic_parent(@cursor), @translation_unit
+			end
+
+			def lexical_parent
+				Cursor.new Lib.get_cursor_lexical_parent(@cursor), @translation_unit
+			end
+
+			def template_kind
+				Lib.get_template_cursor_kind @cursor
+			end
+
+			def access_specifier
+				Lib.get_cxx_access_specifier @cursor
+			end
+
+			def language
+				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)
+				end
+				
+				Lib.visit_children(@cursor, adapter, nil)
+			end
+
+			def linkage
+				Lib.get_cursor_linkage(@cursor)
+			end
+
+			def availability
+				Lib.get_cursor_availability(@cursor)
+			end
+
+			def included_file
+				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 hash
+				Lib.get_cursor_hash(@cursor)
+			end
+
+			def bitfield?
+				Lib.is_bit_field(@cursor) != 0
+			end
+
+			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

@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+# 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/diagnostic'
+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
+
+				@translation_unit = translation_unit
+			end
+
+			def self.release(pointer)
+				Lib.dispose_diagnostic(pointer)
+			end
+
+			def format(opts = {})
+				cxstring = Lib.format_diagnostic(self, display_opts(opts))
+				Lib.extract_string cxstring
+			end
+
+			def severity
+				Lib.get_diagnostic_severity self
+			end
+
+			def spelling
+				Lib.get_string Lib.get_diagnostic_spelling(self)
+			end
+
+			def location
+				sl = Lib.get_diagnostic_location(self)
+				ExpansionLocation.new sl
+			end
+
+			def fixits
+				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
+				n = Lib.get_diagnostic_num_ranges(self)
+				
+				n.times.map {|i| SourceRange.new Lib.get_diagnostic_range(self, i)}
+			end
+
+			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 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
+				else
+					Lib.bitmask_from Lib::DiagnosticDisplayOptions, opts
+				end
+			end
+		end
+	end
+end