ffi-clang/lib/ffi/clang/token.rb

# frozen_string_literal: true

# Released under the MIT License.
# Copyright, 2014, by Masahiro Sano.
# Copyright, 2014-2025, by Samuel Williams.

require_relative "lib/token"
require_relative "lib/cursor"
require_relative "source_location"

module FFI
	module Clang
		# Represents a collection of tokens from a source range.
		class Tokens < AutoPointer
			include Enumerable
			
			# @attribute [Integer] The number of tokens.
			attr_reader :size
			
			# @attribute [Array(Token)] The array of tokens.
			attr_reader :tokens
			
			# Initialize a token collection.
			# @parameter pointer [FFI::Pointer] The tokens pointer.
			# @parameter token_size [Integer] The number of tokens.
			# @parameter translation_unit [TranslationUnit] The parent translation unit.
			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
			
			# Release the tokens pointer.
			# @parameter pointer [Lib::TokensPointer] The tokens pointer to release.
			def self.release(pointer)
				Lib.dispose_tokens(pointer.translation_unit, pointer, pointer.token_size)
			end
			
			# Iterate over each token.
			# @yields {|token| ...} Each token in the collection.
			# 	@parameter token [Token] The token.
			def each(&block)
				@tokens.each do |token|
					block.call(token)
				end
			end
			
			# Get cursors corresponding to each token.
			# @returns [Array(Cursor)] Array of cursors for each token.
			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
		
		# Represents a single token in the source code.
		class Token
			# Initialize a token.
			# @parameter token [FFI::Pointer] The token pointer.
			# @parameter translation_unit [TranslationUnit] The parent translation unit.
			def initialize(token, translation_unit)
				@token = token
				@translation_unit = translation_unit
			end
			
			# Get the kind of this token.
			# @returns [Symbol] The token kind.
			def kind
				Lib.get_token_kind(@token)
			end
			
			# Get the spelling (text) of this token.
			# @returns [String] The token spelling.
			def spelling
				Lib.extract_string Lib.get_token_spelliing(@translation_unit, @token)
			end
			
			# Get the location of this token.
			# @returns [ExpansionLocation] The token location.
			def location
				ExpansionLocation.new Lib.get_token_location(@translation_unit, @token)
			end
			
			# Get the extent (source range) of this token.
			# @returns [SourceRange] The token extent.
			def extent
				SourceRange.new Lib.get_token_extent(@translation_unit, @token)
			end
		end
	end
end