ffi-clang 0.8.0 → 0.10.0

data/lib/ffi/clang/lib/string.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2010, by Jari Bakken.
-# Copyright, 2012, by Hal Brodigan.
-# Copyright, 2013-2022, by Samuel Williams.
+# Copyright, 2013-2024, by Samuel Williams.
 
 module FFI
 	module Clang

data/lib/ffi/clang/lib/translation_unit.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2013-2022, by Samuel Williams.
+# Copyright, 2013-2024, by Samuel Williams.
 # Copyright, 2014, by Masahiro Sano.
 # Copyright, 2019, by Hayden Purdy.
 # Copyright, 2022, by Motonori Iwamuro.
+# Copyright, 2023, by Charlie Savage.
 
 require_relative 'index'
 
@@ -28,7 +29,9 @@ module FFI
 				:single_file_parse, 0x400,
 				:limit_skip_function_bodies_to_preamble, 0x800,
 				:include_attributed_type, 0x1000,
-				:visit_implicit_attributes, 0x2000
+				:visit_implicit_attributes, 0x2000,
+				:ignore_non_errors_from_included_files, 0x4000,
+				:retain_excluded_conditional_blocks, 0x8000,
 			]
 
 			SaveTranslationUnitFlags = enum [
@@ -63,6 +66,14 @@ module FFI
 				:preprocessor_header_search, 14,
 			]
 
+			ErrorCodes = enum [
+				:cx_error_success, 0,
+				:cx_error_failure, 1,
+				:cx_error_crashed, 2,
+				:cx_error_invalid_arguments, 3,
+				:cx_error_ast_read_error, 4,
+			]
+
 			class CXTUResourceUsage < FFI::Struct
 				layout(
 					:data, :pointer,
@@ -80,6 +91,7 @@ module FFI
 
 			# Source code translation units:
 			attach_function :parse_translation_unit, :clang_parseTranslationUnit, [:CXIndex, :string, :pointer, :int, :pointer, :uint, :uint], :CXTranslationUnit
+			attach_function :parse_translation_unit2, :clang_parseTranslationUnit2, [:CXIndex, :string, :pointer, :int, :pointer, :uint, :uint, :pointer], ErrorCodes
 			attach_function :create_translation_unit, :clang_createTranslationUnit, [:CXIndex, :string], :CXTranslationUnit
 			attach_function :dispose_translation_unit, :clang_disposeTranslationUnit, [:CXTranslationUnit], :void
 			attach_function :get_translation_unit_spelling, :clang_getTranslationUnitSpelling, [:CXTranslationUnit], CXString.by_value

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

@@ -2,10 +2,11 @@
 
 # Released under the MIT License.
 # Copyright, 2013, by Carlos Martín Nieto.
-# Copyright, 2013-2022, by Samuel Williams.
+# Copyright, 2013-2024, by Samuel Williams.
 # Copyright, 2013, by Takeshi Watanabe.
 # Copyright, 2013-2014, by Masahiro Sano.
 # Copyright, 2014, by Niklas Therning.
+# Copyright, 2024, by Charlie Savage.
 
 module FFI
 	module Clang
@@ -59,6 +60,71 @@ module FFI
 				:type_variable_array, 115,
 				:type_dependent_sized_array, 116,
 				:type_member_pointer, 117,
+				:type_auto, 118,
+				:type_elaborated, 119,
+				:type_pipe, 120,
+				:type_ocl_image_1d_ro, 121,
+				:type_ocl_image_1d_array_ro, 122,
+				:type_ocl_image_1d_buffer_ro, 123,
+				:type_ocl_image_2d_ro, 124,
+				:type_ocl_image_2d_array_ro, 125,
+				:type_ocl_image_2d_depth_ro, 126,
+				:type_ocl_image_2d_array_depth_ro, 127,
+				:type_ocl_image_2d_msaa_ro, 128,
+				:type_ocl_image_2d_array_msaa_ro, 129,
+				:type_ocl_image_2d_msaa_depth_ro, 130,
+				:type_ocl_image_2d_array_msaa_depth_ro, 131,
+				:type_ocl_image_3d_ro, 132,
+				:type_ocl_image_1d_wo, 133,
+				:type_ocl_image_1d_array_wo, 134,
+				:type_ocl_image_1d_buffer_wo, 135,
+				:type_ocl_image_2d_wo, 136,
+				:type_ocl_image_2d_array_wo, 137,
+				:type_ocl_image_2d_depth_wo, 138,
+				:type_ocl_image_2d_arraydepth_wo, 139,
+				:type_ocl_image_2d_msaa_wo, 140,
+				:type_ocl_image_2d_array_msaa_wo, 141,
+				:type_ocl_image_2d_msaa_depth_wo, 142,
+				:type_ocl_image_2d_array_msaa_depth_wo, 143,
+				:type_ocl_image_3d_wo, 144,
+				:type_ocl_image_1d_rw, 145,
+				:type_ocl_image_1d_array_rw, 146,
+				:type_ocl_image_1d_buffer_rw, 147,
+				:type_ocl_image_2d_rw, 148,
+				:type_ocl_image_2d_array_rw, 149,
+				:type_ocl_image_2d_depth_rw, 150,
+				:type_ocl_image_2d_arraydepth_rw, 151,
+				:type_ocl_image_2d_msaa_rw, 152,
+				:type_ocl_image_2d_array_msaa_rw, 153,
+				:type_ocl_image_2d_msaa_depth_rw, 154,
+				:type_ocl_image_2d_array_msaa_depth_rw, 155,
+				:type_ocl_image_3d_rw, 156,
+				:type_ocl_sampler, 157,
+				:type_ocl_event, 158,
+				:type_ocl_queue, 159,
+				:type_ocl_reserve_id, 160,
+				:type_objc_object, 161,
+				:type_objc_type_param, 162,
+				:type_attributed, 163,
+				:type_ocl_intel_subgroup_avc_mce_payload, 164,
+				:type_ocl_intel_subgroup_avc_ime_payload, 165,
+				:type_ocl_intel_subgroup_avc_ref_payload, 166,
+				:type_ocl_intel_subgroup_avc_sic_payload, 167,
+				:type_ocl_intel_subgroup_avc_mce_result, 168,
+				:type_ocl_intel_subgroup_avc_ime_result, 169,
+				:type_ocl_intel_subgroup_avc_ref_result, 170,
+				:type_ocl_intel_subgroup_avc_sic_result, 171,
+				:type_ocl_intel_subgroup_avc_ime_result_single_reference_streamout, 172,
+				:type_ocl_intel_subgroup_avc_ime_result_dual_reference_streamout, 173,
+				:type_ocl_intel_subgroup_avc_ime_single_reference_streamin, 174,
+				:type_ocl_intel_subgroup_avc_ime_dual_reference_streamin, 175,
+				:type_ocl_intel_subgroup_avc_ime_result_single_ref_streamout, 172,
+				:type_ocl_intel_subgroup_avc_ime_result_dual_ref_streamout, 173,
+				:type_ocl_intel_subgroup_avc_ime_single_ref_streamin, 174,
+				:type_ocl_intel_subgroup_avc_ime_dual_ref_streamin, 175,
+				:type_ext_vector, 176,
+				:type_atomic, 177,
+				:type_btf_tag_attributed, 178
 			]
 
 			enum :calling_conv, [
@@ -74,6 +140,16 @@ module FFI
 				:calling_conv_intel_ocl_bicc, 9,
 				:calling_conv_x86_64_win64, 10,
 				:calling_conv_x86_64_sysv, 11,
+				:calling_conv_x86_vector_call, 12,
+				:calling_conv_swift, 13,
+				:calling_conv_preserve_most, 14,
+				:calling_conv_preserve_all, 15,
+				:calling_conv_aarch64_vector_call, 16,
+				:calling_conv_swift_async, 17,
+				:calling_conv_aarch64_sve_pcs, 18,
+				:calling_conv_m68k_rtd, 19,
+				:calling_conv_preserve_none, 20,
+				:calling_conv_riscv_vector_call, 21,
 				:calling_conv_invalid, 100,
 				:calling_conv_unexposed, 200
 			]
@@ -90,6 +166,7 @@ module FFI
 				:layout_error_dependent, -3,
 				:layout_error_not_constant_size, -4,
 				:layout_error_invalid_field_name, -5,
+				:layout_error_undeduced, -6
 			]
 
 			class CXType < FFI::Struct
@@ -108,7 +185,7 @@ module FFI
 			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
-			
+
 			attach_function :type_get_class_type, :clang_Type_getClassType, [CXType.by_value], CXType.by_value
 
 			attach_function :is_const_qualified_type, :clang_isConstQualifiedType, [CXType.by_value], :uint
@@ -127,7 +204,7 @@ module FFI
 			attach_function :type_get_offset_of, :clang_Type_getOffsetOf, [CXType.by_value, :string], :long_long
 
 			attach_function :type_get_cxx_ref_qualifier, :clang_Type_getCXXRefQualifier, [CXType.by_value], :ref_qualifier_kind
-			
+
 			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

data/lib/ffi/clang/lib.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2010-2012, by Jari Bakken.
 # Copyright, 2012, by Hal Brodigan.
-# Copyright, 2013-2022, by Samuel Williams.
+# Copyright, 2013-2024, by Samuel Williams.
 # Copyright, 2013-2014, by Carlos Martín Nieto.
 # Copyright, 2013, by Takeshi Watanabe.
 # Copyright, 2014, by Masahiro Sano.
@@ -12,7 +12,8 @@
 # Copyright, 2016, by Mike Dalessio.
 # Copyright, 2019, by Hayden Purdy.
 # Copyright, 2019, by Dominic Sisnero.
-# Copyright, 2020, by Luikore.
+# Copyright, 2020, by Zete Lui.
+# Copyright, 2023, by Charlie Savage.
 
 require 'mkmf'
 
@@ -69,11 +70,11 @@ module FFI
 			def self.bitmask_from(enum, opts)
 				bitmask = 0
 
-				opts.each do |key, value|
-					if int = enum[key]
+				opts.each do |symbol|
+					if int = enum[symbol]
 						bitmask |= int
 					else
-						raise Error, "unknown option: #{key.inspect}, expected one of #{enum.symbols}"
+  						raise Error, "unknown option: #{symbol}, expected one of #{enum.symbols}"
 					end
 				end
 
@@ -82,19 +83,19 @@ module FFI
 
 			def self.opts_from(enum, bitmask)
 				bit = 1
-				opts = {}
+				result = []
 				while bitmask != 0
 					if bitmask & 1
-						if sym = enum[bit]
-							opts[sym] = true
+						if symbol = enum[bit]
+							result << symbol
 						else
-							raise Error, "unknown values: #{bit}, expected one of #{enum.symbols}"
+							raise(Error, "unknown values: #{bit}, expected one of #{enum.symbols}")
 						end
 					end
 					bitmask >>= 1
 					bit <<= 1
 				end
-				opts
+				result
 			end
 		end
 	end

data/lib/ffi/clang/printing_policy.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Charlie Savage.
+# Copyright, 2024, by Samuel Williams.
+
+require_relative 'lib/printing_policy'
+
+module FFI
+	module Clang
+		class PrintingPolicy < AutoPointer
+			def initialize(cursor)
+        policy = Lib.get_printing_policy(cursor)
+				super(policy)
+        @cursor = cursor
+			end
+
+			def self.release(pointer)
+				Lib.dispose_printing_policy(pointer)
+			end
+
+      def get_property(property)
+        result = Lib.printing_policy_get_property(self, property)
+        result == 0 ? false : true
+      end
+
+      def set_property(property, value)
+        Lib.printing_policy_set_property(self, property, value ? 1 : 0)
+      end
+
+      def pretty_print
+        Lib.extract_string Lib.pretty_print(@cursor, self)
+      end
+		end
+	end
+end

data/lib/ffi/clang/source_location.rb

@@ -6,6 +6,7 @@
 # Copyright, 2013-2022, by Samuel Williams.
 # Copyright, 2013, by Garry Marshall.
 # Copyright, 2014, by Masahiro Sano.
+# Copyright, 2024, by Charlie Savage.
 
 require_relative 'lib/source_location'
 require_relative 'lib/file'
@@ -30,22 +31,6 @@ module FFI
 				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
@@ -73,6 +58,14 @@ module FFI
 				@column = column.get_uint(0)
 				@offset = offset.get_uint(0)
 			end
+
+			def as_string
+				"#{@file}:#{@line}:#{@column}:#{@offset}"
+			end
+
+			def to_s
+				"ExpansionLocation <#{self.as_string}>"
+			end
 		end
 
 		class PresumedLocation < SourceLocation
@@ -82,8 +75,8 @@ module FFI
 				super(location)
 
 				cxstring = MemoryPointer.new Lib::CXString
-				line	 = MemoryPointer.new :uint
-				column	 = MemoryPointer.new :uint
+				line = MemoryPointer.new :uint
+				column = MemoryPointer.new :uint
 
 				Lib::get_presumed_location(@location, cxstring, line, column)
 
@@ -91,6 +84,14 @@ module FFI
 				@line = line.get_uint(0)
 				@column = column.get_uint(0)
 			end
+
+			def as_string
+				"#{@filename}:#{@line}:#{@column}"
+			end
+
+			def to_s
+				"PresumedLocation <#{self.as_string}>"
+			end
 		end
 
 		class SpellingLocation < SourceLocation
@@ -111,6 +112,14 @@ module FFI
 				@column = column.get_uint(0)
 				@offset = offset.get_uint(0)
 			end
+
+			def as_string
+				"#{@file}:#{@line}:#{@column}:#{@offset}"
+			end
+
+			def to_s
+				"SpellingLocation <#{self.as_string}>"
+			end
 		end
 
 		class FileLocation < SourceLocation
@@ -131,6 +140,14 @@ module FFI
 				@column = column.get_uint(0)
 				@offset = offset.get_uint(0)
 			end
+
+			def as_string
+				"#{@file}:#{@line}:#{@column}:#{@offset}"
+			end
+
+			def to_s
+				"FileLocation <#{self.as_string}>"
+			end
 		end
 	end
 end

data/lib/ffi/clang/types/array.rb

@@ -0,0 +1,15 @@
+module FFI
+	module Clang
+		module Types
+			class Array < Type
+				def element_type
+					Type.create Lib.get_array_element_type(@type), @translation_unit
+				end
+
+				def size
+					Lib.get_array_size(@type)
+				end
+			end
+		end
+	end
+end

data/lib/ffi/clang/types/elaborated.rb

@@ -0,0 +1,26 @@
+module FFI
+	module Clang
+		module Types
+			class Elaborated < Type
+				def canonical
+					Type.create Lib.get_canonical_type(@type), @translation_unit
+				end
+
+				# Example anonymous union where `u` is an elaborated type
+				#
+				#	 typedef struct {
+				#		 union {
+				#			 int idata;
+				#		 } u;
+				#	 } SomeStruct;
+				def anonymous?
+					self.declaration.anonymous?
+				end
+
+				def pointer?
+					self.canonical.is_a?(Pointer)
+				end
+			end
+		end
+	end
+end

data/lib/ffi/clang/types/function.rb

@@ -0,0 +1,27 @@
+module FFI
+	module Clang
+		module Types
+			class Function < Type
+				def variadic?
+					Lib.is_function_type_variadic(@type) != 0
+				end
+
+				def args_size
+					Lib.get_num_arg_types(@type)
+				end
+
+				def arg_type(i)
+					Type.create Lib.get_arg_type(@type, i), @translation_unit
+				end
+
+				def result_type
+					Type.create Lib.get_result_type(@type), @translation_unit
+				end
+
+				def calling_conv
+					Lib.get_fuction_type_calling_conv(@type)
+				end
+			end
+		end
+	end
+end

data/lib/ffi/clang/types/pointer.rb

@@ -0,0 +1,42 @@
+module FFI
+	module Clang
+		module Types
+			class Pointer < Type
+				def pointee
+					Type.create Lib.get_pointee_type(@type), @translation_unit
+				end
+
+				def function?
+					self.pointee.is_a?(Types::Function)
+				end
+
+				def class_type
+					if self.kind == :type_member_pointer
+						Type.create Lib.type_get_class_type(@type), @translation_unit
+					else
+						nil
+					end
+				end
+
+				def forward_declaration?
+					# Is this a pointer to a record (struct or union) that referenced
+					# a forward declaration at the point of its inclusion in the translation unit?
+					if !self.function? && self.pointee.is_a?(Types::Elaborated) &&
+						 self.pointee.canonical.is_a?(Types::Record)
+
+						# Get the universal symbol reference
+						usr = self.pointee.canonical.declaration.usr
+
+						# Now does that same usr occur earlier in the file?
+						first_declaration, _ = self.translation_unit.cursor.find do |child, parent|
+							child.usr == usr
+						end
+						# NOTE - Maybe should also check that the line number of
+						# is less than the line number of the declaration this type references
+						first_declaration.forward_declaration?
+					end
+				end
+			end
+		end
+	end
+end

data/lib/ffi/clang/types/record.rb

@@ -0,0 +1,26 @@
+module FFI
+	module Clang
+		module Types
+			class Record < Type
+				def offsetof(field)
+					Lib.type_get_offset_of(@type, field)
+				end
+
+				def anonymous?
+					self.spelling.match(/unnamed/)
+				end
+
+				def record_type
+					case self.spelling
+						when /struct/
+							:struct
+						when /union/
+							:union
+						else
+							raise("Unknown record type: #{self.spelling}")
+					end
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2013, by Carlos Martín Nieto.
+# Copyright, 2013-2024, by Samuel Williams.
+# Copyright, 2013, by Takeshi Watanabe.
+# Copyright, 2014, by Masahiro Sano.
+# Copyright, 2014, by Niklas Therning.
+# Copyright, 2024, by Charlie Savage.
+
+module FFI
+	module Clang
+		module Types
+			class Type
+				attr_reader :type, :translation_unit
+
+				# Just hard code the types - they don't likely to change
+				def self.create(cxtype, translation_unit)
+					case cxtype[:kind]
+						when :type_pointer, :type_block_pointer, :type_obj_c_object_pointer, :type_member_pointer
+							Pointer.new(cxtype, translation_unit)
+						when :type_constant_array, :type_incomplete_array, :type_variable_array, :type_dependent_sized_array
+							Array.new(cxtype, translation_unit)
+						when :type_vector
+							Vector.new(cxtype, translation_unit)
+						when :type_function_no_proto, :type_function_proto
+							Function.new(cxtype, translation_unit)
+						when :type_elaborated
+							Elaborated.new(cxtype, translation_unit)
+						when :type_typedef
+							TypeDef.new(cxtype, translation_unit)
+						when :type_record
+							Record.new(cxtype, translation_unit)
+						else
+							Type.new(cxtype, translation_unit)
+					end
+				end
+
+				def initialize(type, translation_unit)
+					@type = type
+					@translation_unit = translation_unit
+				end
+
+				def kind
+					@type[:kind]
+				end
+
+				def kind_spelling
+					Lib.extract_string Lib.get_type_kind_spelling @type[:kind]
+				end
+
+				def spelling
+					Lib.extract_string Lib.get_type_spelling(@type)
+				end
+
+				def pod?
+					Lib.is_pod_type(@type) != 0
+				end
+
+				def const_qualified?
+					Lib.is_const_qualified_type(@type) != 0
+				end
+
+				def volatile_qualified?
+					Lib.is_volatile_qualified_type(@type) != 0
+				end
+
+				def restrict_qualified?
+					Lib.is_restrict_qualified_type(@type) != 0
+				end
+
+				def alignof
+					Lib.type_get_align_of(@type)
+				end
+
+				def sizeof
+					Lib.type_get_size_of(@type)
+				end
+
+				def ref_qualifier
+					Lib.type_get_cxx_ref_qualifier(@type)
+				end
+
+				def declaration
+					Cursor.new Lib.get_type_declaration(@type), @translation_unit
+				end
+
+				def ==(other)
+					Lib.equal_types(@type, other.type) != 0
+				end
+
+				def to_s
+					"#{self.class.name} <#{self.kind}: #{self.spelling}>"
+				end
+			end
+		end
+	end
+end

data/lib/ffi/clang/types/type_def.rb

@@ -0,0 +1,15 @@
+module FFI
+	module Clang
+		module Types
+			class TypeDef < Type
+				def canonical
+					Type.create Lib.get_canonical_type(@type), @translation_unit
+				end
+
+				def anonymous?
+					self.canonical.kind == :type_record && self.canonical.anonymous?
+				end
+			end
+		end
+	end
+end

data/lib/ffi/clang/types/vector.rb

@@ -0,0 +1,15 @@
+module FFI
+	module Clang
+		module Types
+			class Vector < Type
+				def element_type
+					Type.create Lib.get_element_type(@type), @translation_unit
+				end
+
+				def size
+					Lib.get_num_elements(@type)
+				end
+			end
+		end
+	end
+end

data/lib/ffi/clang/version.rb

@@ -3,10 +3,10 @@
 # Released under the MIT License.
 # Copyright, 2010, by Jari Bakken.
 # Copyright, 2012, by Hal Brodigan.
-# Copyright, 2013-2022, by Samuel Williams.
+# Copyright, 2013-2024, by Samuel Williams.
 
 module FFI
 	module Clang
-		VERSION = "0.8.0"
+		VERSION = "0.10.0"
 	end
 end

data/lib/ffi/clang.rb

@@ -46,3 +46,12 @@ require_relative 'clang/unsaved_file'
 require_relative 'clang/token'
 require_relative 'clang/code_completion'
 require_relative 'clang/compilation_database'
+
+require_relative 'clang/types/type'
+require_relative 'clang/types/array'
+require_relative 'clang/types/elaborated'
+require_relative 'clang/types/function'
+require_relative 'clang/types/pointer'
+require_relative 'clang/types/record'
+require_relative 'clang/types/type_def'
+require_relative 'clang/types/vector'

data/license.md

@@ -2,7 +2,7 @@
 
 Copyright, 2010-2012, by Jari Bakken.  
 Copyright, 2012, by Hal Brodigan.  
-Copyright, 2013-2022, by Samuel Williams.  
+Copyright, 2013-2024, by Samuel Williams.  
 Copyright, 2013, by Garry Marshall.  
 Copyright, 2013-2014, by Carlos Martín Nieto.  
 Copyright, 2013, by Dave Wilkinson.  
@@ -16,8 +16,9 @@ Copyright, 2017, by Cameron Dutro.
 Copyright, 2019, by Hayden Purdy.  
 Copyright, 2019, by Michael Metivier.  
 Copyright, 2019, by Dominic Sisnero.  
-Copyright, 2020, by Luikore.  
+Copyright, 2020, by Zete Lui.  
 Copyright, 2022, by Motonori Iwamuro.  
+Copyright, 2023-2024, by Charlie Savage.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal