ffi-clang 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7bac4481c13b37b86189208dd7e0589bd96a42059319828c22ae623025ccc75
-  data.tar.gz: 3d6cc4ebca61f93b710b5a8fcc80d6fa51eeb8aac466246775c5ba80d8274c32
+  metadata.gz: eed14776878ea1dd5fe61ec2b8c9bb57be78116944d5943722077dd958e65b90
+  data.tar.gz: 15acda164aae15f941ae12031e1f68a8a220f0b5e48c6ed07737e0d8a733893d
 SHA512:
-  metadata.gz: 816df5fbe722de3c3bc513598455a076bc64a32ee0d4d1697bc51dca767d06b9645be1c6dba444bc50d9d3f073fc02b2d13c6afbce355617df03368dc416930c
-  data.tar.gz: ec3be8892d6710742e173e54cb6c4f498b28a5178ca7c15ad9c08aae66f67824a039820f7ddff0a21c8aa50221c286dbeef9a2132e140bebb8c5f65fc69928c9
+  metadata.gz: bb918188b02394a8d21f863f1b989a2cb96789f11c97d83c417258ac25a590e63297daf7e7fb6851f06e4890051f9130b9c75d850f1662ad29f6652a244bceb4
+  data.tar.gz: 6b48dabf35dc7606859f18f4267800f4e6de1a2eec1496e3e89cbad282727cb8f80c4820b1405e772bad59bfd8559a98076804e2320b453d65e0d22104ba9bd0

data/lib/ffi/clang/cursor.rb

@@ -20,11 +20,12 @@ require_relative 'printing_policy'
 require_relative 'source_location'
 require_relative 'source_range'
 require_relative 'comment'
-require_relative 'type'
 
 module FFI
 	module Clang
 		class Cursor
+			include Enumerable
+
 			attr_reader :cursor
 			attr_reader :translation_unit
 
@@ -62,6 +63,14 @@ module FFI
 				CodeCompletion::String.new Lib.get_cursor_completion_string(@cursor)
 			end
 
+			def anonymous?
+				Lib.cursor_is_anonymous(@cursor) != 0
+			end
+
+			def anonymous_record_declaration?
+				Lib.cursor_is_anonymous_record_decl(@cursor) != 0
+			end
+
 			def declaration?
 				Lib.is_declaration(kind) != 0
 			end
@@ -155,7 +164,7 @@ module FFI
 			end
 
 			def kind
-				@cursor[:kind]
+				@cursor ? @cursor[:kind] : nil
 			end
 
 			def kind_spelling
@@ -163,15 +172,15 @@ module FFI
 			end
 
 			def type
-				Type.new Lib.get_cursor_type(@cursor), @translation_unit
+				Types::Type.create Lib.get_cursor_type(@cursor), @translation_unit
 			end
 
 			def result_type
-				Type.new Lib.get_cursor_result_type(@cursor), @translation_unit
+				Types::Type.create Lib.get_cursor_result_type(@cursor), @translation_unit
 			end
 
 			def underlying_type
-				Type.new Lib.get_typedef_decl_underlying_type(@cursor), @translation_unit
+				Types::Type.create Lib.get_typedef_decl_underlying_type(@cursor), @translation_unit
 			end
 
 			def virtual_base?
@@ -211,7 +220,7 @@ module FFI
 			end
 
 			def enum_type
-				Type.new Lib.get_enum_decl_integer_type(@cursor), @translation_unit
+				Types::Type.create Lib.get_enum_decl_integer_type(@cursor), @translation_unit
 			end
 
 			def specialized_template
@@ -269,14 +278,53 @@ module FFI
 				Lib.get_num_args @cursor
 			end
 
-			def visit_children(&block)
+			def each(recurse = true, &block)
+				return to_enum(:each, recurse) unless block_given?
+
 				adapter = Proc.new do |cxcursor, parent_cursor, unused|
-					block.call Cursor.new(cxcursor, @translation_unit), Cursor.new(parent_cursor, @translation_unit)
+					# Call the block and capture the result. This lets advanced users
+					# modify the recursion on a case by case basis if needed
+					result = block.call Cursor.new(cxcursor, @translation_unit), Cursor.new(parent_cursor, @translation_unit)
+					case result
+						when :continue
+							:continue
+						when :recurse
+							:recurse
+						else
+							recurse ? :recurse : :continue
+					end
 				end
-				
+
 				Lib.visit_children(@cursor, adapter, nil)
 			end
 
+      def ancestors_by_kind(*kinds)
+        result = Array.new
+
+        parent = self
+        while parent != self.semantic_parent
+          parent = self.semantic_parent
+          if kinds.include?(parent.kind)
+            result << parent
+          end
+        end
+        result
+      end
+
+			def find_by_kind(recurse, *kinds)
+        unless (recurse == nil || recurse == true || recurse == false)
+          raise("Recurse parameter must be nil or a boolean value. Value was: #{recurse}")
+        end
+
+				result = Array.new
+				self.each(recurse) do |child, parent|
+					if kinds.include?(child.kind)
+						result << child
+					end
+				end
+				result
+			end
+
 			def find_references_in_file(file = nil, &block)
 				file ||= Lib.extract_string Lib.get_translation_unit_spelling(@translation_unit)
 
@@ -384,46 +432,10 @@ module FFI
 				Lib.get_cursor_hash(@cursor)
 			end
 
-			def find_all(*kinds)
-				filter do |child, parent|
-					kinds.include?(child.kind)
-				end
-			end
-
-			def find_first(*kinds)
-				find_all(*kinds).first
-			end
-
-			def filter
-				return to_enum(:select) unless block_given?
-				
-				matching = []
-
-				self.visit_children do |child, parent|
-					if yield(child, parent)
-						matching << child
-					end
-
-					:recurse
-				end
-
-				return matching
-			end
-
-			def select
-				filter do |child, parent|
-					yield(child)
-				end
-			end
-
 			def to_s
 				"Cursor <#{self.kind.to_s.gsub(/^cursor_/, '')}: #{self.spelling}>"
 			end
 
-			def to_a
-				filter.collect{|child, parent| child}
-			end
-
 			def references(file = nil)
 				refs = []
 				self.find_references_in_file(file) do |cursor, unused|

data/lib/ffi/clang/lib/cursor.rb

@@ -441,6 +441,8 @@ module FFI
 			attach_function :find_references_in_file, :clang_findReferencesInFile, [CXCursor.by_value, :CXFile, CXCursorAndRangeVisitor.by_value], :result
 
 			attach_function :get_cursor_type, :clang_getCursorType, [CXCursor.by_value], CXType.by_value
+			attach_function :cursor_is_anonymous, :clang_Cursor_isAnonymous, [CXCursor.by_value], :uint
+			attach_function :cursor_is_anonymous_record_decl, :clang_Cursor_isAnonymousRecordDecl, [CXCursor.by_value], :uint
 			attach_function :get_cursor_result_type, :clang_getCursorResultType, [CXCursor.by_value], CXType.by_value
 			attach_function :get_typedef_decl_underlying_type, :clang_getTypedefDeclUnderlyingType, [CXCursor.by_value], CXType.by_value
 			attach_function :get_enum_decl_integer_type, :clang_getEnumDeclIntegerType, [CXCursor.by_value], CXType.by_value

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

@@ -7,6 +7,6 @@
 
 module FFI
 	module Clang
-		VERSION = "0.9.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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-clang
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -55,7 +55,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-04-07 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -110,7 +110,14 @@ files:
 - lib/ffi/clang/source_range.rb
 - lib/ffi/clang/token.rb
 - lib/ffi/clang/translation_unit.rb
-- lib/ffi/clang/type.rb
+- lib/ffi/clang/types/array.rb
+- lib/ffi/clang/types/elaborated.rb
+- lib/ffi/clang/types/function.rb
+- lib/ffi/clang/types/pointer.rb
+- lib/ffi/clang/types/record.rb
+- lib/ffi/clang/types/type.rb
+- lib/ffi/clang/types/type_def.rb
+- lib/ffi/clang/types/vector.rb
 - lib/ffi/clang/unsaved_file.rb
 - lib/ffi/clang/version.rb
 - license.md
@@ -136,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Ruby FFI bindings for libclang C interface.

data/lib/ffi/clang/type.rb

@@ -1,160 +0,0 @@
-# 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
-		class Type
-			attr_reader :type
-
-			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 variadic?
-				Lib.is_function_type_variadic(@type) != 0
-			end
-
-			def pod?
-				Lib.is_pod_type(@type) != 0
-			end
-
-			def num_arg_types
-				Lib.get_num_arg_types(@type)
-			end
-
-			def pointer?
-				[:type_pointer, :type_block_pointer, :type_obj_c_object_pointer, :type_member_pointer].
-					include?(self.kind)
-			end
-
-			def pointee
-				if self.pointer?
-					Type.new Lib.get_pointee_type(@type), @translation_unit
-				else
-					nil
-				end
-			end
-
-			def canonical
-				Type.new Lib.get_canonical_type(@type), @translation_unit
-			end
-
-			def class_type
-				if self.kind == :type_member_pointer
-					Type.new Lib.type_get_class_type(@type), @translation_unit
-				else
-					nil
-				end
-			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 function?
-				[:type_function_no_proto, :type_function_proto].include?(self.kind)
-			end
-
-			def arg_type(i)
-				if self.function?
-					Type.new Lib.get_arg_type(@type, i), @translation_unit
-				else
-					nil
-				end
-			end
-
-			def result_type
-				if self.function?
-					Type.new Lib.get_result_type(@type), @translation_unit
-				else
-					nil
-				end
-			end
-
-			def element_type
-				if self.array? || [:type_vector, :type_complex].include?(self.kind)
-					Type.new Lib.get_element_type(@type), @translation_unit
-				else
-					nil
-				end
-			end
-
-			def num_elements
-				Lib.get_num_elements(@type)
-			end
-
-			def array?
-				[:type_constant_array, :type_incomplete_array, :type_variable_array, :type_dependent_sized_array].
-					include?(self.kind)
-			end
-
-			def array_element_type
-				if self.array?
-					Type.new Lib.get_array_element_type(@type), @translation_unit
-				else
-					nil
-				end
-			end
-
-			def array_size
-				Lib.get_array_size(@type)
-			end
-
-			def alignof
-				Lib.type_get_align_of(@type)
-			end
-
-			def sizeof
-				Lib.type_get_size_of(@type)
-			end
-
-			def offsetof(field)
-				Lib.type_get_offset_of(@type, field)
-			end
-
-			def ref_qualifier
-				Lib.type_get_cxx_ref_qualifier(@type)
-			end
-
-			def calling_conv
-				Lib.get_fuction_type_calling_conv(@type)
-			end
-
-			def declaration
-				Cursor.new Lib.get_type_declaration(@type), @translation_unit
-			end
-
-			def ==(other)
-				Lib.equal_types(@type, other.type) != 0
-			end
-		end
-	end
-end