ghazel-ffi-clang 0.2.0.1

data/lib/ffi/clang/lib/type.rb

@@ -0,0 +1,154 @@
+# 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.
+
+module FFI
+	module Clang
+		module Lib
+			enum :kind, [
+				:type_invalid, 0,
+				:type_unexposed, 1,
+				:type_void, 2,
+				:type_bool, 3,
+				:type_char_u, 4,
+				:type_uchar, 5,
+				:type_char16, 6,
+				:type_char32, 7,
+				:type_ushort, 8,
+				:type_uint, 9,
+				:type_ulong, 10,
+				:type_ulonglong, 11,
+				:type_uint128, 12,
+				:type_char_s, 13,
+				:type_schar, 14,
+				:type_wchar, 15,
+				:type_short, 16,
+				:type_int, 17,
+				:type_long, 18,
+				:type_longlong, 19,
+				:type_int128, 20,
+				:type_float, 21,
+				:type_double, 22,
+				:type_longdouble, 23,
+				:type_nullptr, 24,
+				:type_overload, 25,
+				:type_dependent, 26,
+				:type_obj_c_id, 27,
+				:type_obj_c_class, 28,
+				:type_obj_c_sel, 29,
+				:type_complex, 100,
+				:type_pointer, 101,
+				:type_block_pointer, 102,
+				:type_lvalue_ref, 103,
+				:type_rvalue_ref, 104,
+				:type_record, 105,
+				:type_enum, 106,
+				:type_typedef, 107,
+				:type_obj_c_interface, 108,
+				:type_obj_c_object_pointer, 109,
+				:type_function_no_proto, 110,
+				:type_function_proto, 111,
+				:type_constant_array, 112,
+				:type_vector, 113,
+				:type_incomplete_array, 114,
+				:type_variable_array, 115,
+				:type_dependent_sized_array, 116,
+				:type_member_pointer, 117,
+			]
+
+			enum :calling_conv, [
+				:calling_conv_default, 0,
+				:calling_conv_c, 1,
+				:calling_conv_x86_stdcall, 2,
+				:calling_conv_x86_fastcall, 3,
+				:calling_conv_x86_thiscall, 4,
+				:calling_conv_x86_pascal, 5,
+				:calling_conv_aapcs, 6,
+				:calling_conv_aapcs_vfp, 7,
+				:calling_conv_pnacl_call, 8,
+				:calling_conv_intel_ocl_bicc, 9,
+				:calling_conv_x86_64_win64, 10,
+				:calling_conv_x86_64_sysv, 11,
+				:calling_conv_invalid, 100,
+				:calling_conv_unexposed, 200
+			]
+
+			enum :ref_qualifier_kind, [
+				:ref_qualifier_none, 0,
+				:ref_qualifier_lvalue, 1,
+				:ref_qualifier_rvalue, 2,
+			]
+
+			enum :layout_error, [
+				:layout_error_invalid, -1,
+				:layout_error_incomplete, -2,
+				:layout_error_dependent, -3,
+				:layout_error_not_constant_size, -4,
+				:layout_error_invalid_field_name, -5,
+			]
+
+			class CXType < FFI::Struct
+				layout(
+					:kind, :kind,
+					:data, [:pointer, 2]
+				)
+			end
+
+			attach_function :get_type_kind_spelling, :clang_getTypeKindSpelling, [:kind], CXString.by_value
+			if FFI::Clang::Utils.satisfy_version?('3.3')
+				attach_function :get_type_spelling, :clang_getTypeSpelling, [CXType.by_value], CXString.by_value
+			end
+
+			attach_function :is_function_type_variadic, :clang_isFunctionTypeVariadic, [CXType.by_value], :uint
+			attach_function :is_pod_type, :clang_isPODType, [CXType.by_value], :uint
+
+			attach_function :get_pointee_type, :clang_getPointeeType, [CXType.by_value], CXType.by_value
+			attach_function :get_result_type, :clang_getResultType, [CXType.by_value], CXType.by_value
+			attach_function :get_canonical_type, :clang_getCanonicalType, [CXType.by_value], CXType.by_value
+			if FFI::Clang::Utils.satisfy_version?('3.4')
+				attach_function :type_get_class_type, :clang_Type_getClassType, [CXType.by_value], CXType.by_value
+			end
+
+			attach_function :is_const_qualified_type, :clang_isConstQualifiedType, [CXType.by_value], :uint
+			attach_function :is_volatile_qualified_type, :clang_isVolatileQualifiedType, [CXType.by_value], :uint
+			attach_function :is_restrict_qualified_type, :clang_isRestrictQualifiedType, [CXType.by_value], :uint
+
+			attach_function :get_num_arg_types, :clang_getNumArgTypes, [CXType.by_value], :int
+			attach_function :get_arg_type, :clang_getArgType, [CXType.by_value, :uint], CXType.by_value
+			attach_function :get_num_elements, :clang_getNumElements, [CXType.by_value], :long_long
+			attach_function :get_element_type, :clang_getElementType, [CXType.by_value], CXType.by_value
+			attach_function :get_array_size, :clang_getArraySize, [CXType.by_value], :long_long
+			attach_function :get_array_element_type ,:clang_getArrayElementType, [CXType.by_value], CXType.by_value
+
+			if FFI::Clang::Utils.satisfy_version?('3.3')
+				attach_function :type_get_align_of, :clang_Type_getAlignOf, [CXType.by_value], :long_long
+				attach_function :type_get_size_of, :clang_Type_getSizeOf, [CXType.by_value], :long_long
+				attach_function :type_get_offset_of, :clang_Type_getOffsetOf, [CXType.by_value, :string], :long_long
+			end
+
+			if FFI::Clang::Utils.satisfy_version?('3.4')
+				attach_function :type_get_cxx_ref_qualifier, :clang_Type_getCXXRefQualifier, [CXType.by_value], :ref_qualifier_kind
+			end
+			attach_function :get_fuction_type_calling_conv, :clang_getFunctionTypeCallingConv, [CXType.by_value], :calling_conv
+
+			attach_function :equal_types, :clang_equalTypes, [CXType.by_value, CXType.by_value], :uint
+		end
+	end
+end

data/lib/ffi/clang/lib/utils.rb

@@ -0,0 +1,29 @@
+# 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/string'
+
+module FFI
+	module Clang
+		module Lib
+			attach_function :get_clang_version, :clang_getClangVersion, [], CXString.by_value
+		end
+	end
+end

data/lib/ffi/clang/source_location.rb

@@ -0,0 +1,149 @@
+# 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/source_location'
+require 'ffi/clang/lib/file'
+
+module FFI
+	module Clang
+		class SourceLocation
+			def self.null_location
+				ExpansionLocation.new Lib.get_null_location
+			end
+
+			attr_reader :location
+			def initialize(location)
+				@location = location
+			end
+
+			def in_system_header?
+				Lib.location_in_system_header(@location) != 0
+			end
+
+			def from_main_file?
+				Lib.location_is_from_main_file(@location) != 0
+			end
+
+			def expansion_location
+				ExpansionLocation.new(@location)
+			end
+
+			def presumed_location
+				PresumedLocation.new(@location)
+			end
+
+			def spelling_location
+				SpellingLocation.new(@location)
+			end
+
+			def file_location
+				FileLocation.new(@location)
+			end
+
+			def null?
+				Lib.equal_locations(@location, Lib.get_null_location) != 0
+			end
+
+			def ==(other)
+				Lib.equal_locations(@location, other.location) != 0
+			end
+		end
+
+		class ExpansionLocation < SourceLocation
+			attr_reader :file, :line, :column, :offset
+
+			def initialize(location)
+				super(location)
+
+				cxfile = MemoryPointer.new :pointer
+				line   = MemoryPointer.new :uint
+				column = MemoryPointer.new :uint
+				offset = MemoryPointer.new :uint
+
+				Lib::get_expansion_location(@location, cxfile, line, column, offset)
+
+				@file = Lib.extract_string Lib.get_file_name(cxfile.read_pointer)
+				@line = line.get_uint(0)
+				@column = column.get_uint(0)
+				@offset = offset.get_uint(0)
+			end
+		end
+
+		class PresumedLocation < SourceLocation
+			attr_reader :filename, :line, :column, :offset
+
+			def initialize(location)
+				super(location)
+
+				cxstring = MemoryPointer.new Lib::CXString
+				line	 = MemoryPointer.new :uint
+				column	 = MemoryPointer.new :uint
+
+				Lib::get_presumed_location(@location, cxstring, line, column)
+
+				@filename = Lib.extract_string cxstring
+				@line = line.get_uint(0)
+				@column = column.get_uint(0)
+			end
+		end
+
+		class SpellingLocation < SourceLocation
+			attr_reader :file, :line, :column, :offset
+
+			def initialize(location)
+				super(location)
+
+				cxfile = MemoryPointer.new :pointer
+				line   = MemoryPointer.new :uint
+				column = MemoryPointer.new :uint
+				offset = MemoryPointer.new :uint
+
+				Lib::get_spelling_location(@location, cxfile, line, column, offset)
+
+				@file = Lib.extract_string Lib.get_file_name(cxfile.read_pointer)
+				@line = line.get_uint(0)
+				@column = column.get_uint(0)
+				@offset = offset.get_uint(0)
+			end
+		end
+
+		class FileLocation < SourceLocation
+			attr_reader :file, :line, :column, :offset
+
+			def initialize(location)
+				super(location)
+
+				cxfile = MemoryPointer.new :pointer
+				line   = MemoryPointer.new :uint
+				column = MemoryPointer.new :uint
+				offset = MemoryPointer.new :uint
+
+				Lib::get_file_location(@location, cxfile, line, column, offset)
+
+				@file = Lib.extract_string Lib.get_file_name(cxfile.read_pointer)
+				@line = line.get_uint(0)
+				@column = column.get_uint(0)
+				@offset = offset.get_uint(0)
+			end
+		end
+	end
+end

data/lib/ffi/clang/source_range.rb

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+# 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
+# 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/source_range'
+
+module FFI
+	module Clang
+		class SourceRange
+			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
+				ExpansionLocation.new(Lib.get_range_start @range)
+			end
+
+			def end
+				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
+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