Godot4 Object / RefCounted 派生のメモリリークテスト

extends Node2D

## new クラス関数による生成時、このオブジェクトが消去される際に
## 関数がどのタイミングで呼び出されるかを print 出力で確認するためのインナークラスです。
## test_study_inner_class1.gd で GUT によるテストでメモリリークがないかを確認します。
class InnerClassA extends Object:
	## インナークラスを作るために、メンバ変数を適当に持たせます。
	var id: int
	
	## コンストラクタの仮想関数です。
	func _init() -> void:
		print("InnerClassA:_init called")
		return
	
	## オブジェクトが消去される直前などに通知してくるイベント関数です。
	func _notification(what: int) -> void:
		print("InnerClassA:_notification called what = ", what)
		if what == NOTIFICATION_PREDELETE:	# 実質的なデストラクタ
			print("InnerClassA:_notification what = NOTIFICATION_PREDELETE")
		elif what == NOTIFICATION_POSTINITIALIZE:
			print("InnerClassA:_notification what = NOTIFICATION_POSTINITIALIZE")
		elif what == NOTIFICATION_EXTENSION_RELOADED:
			print("InnerClassA:_notification what = NOTIFICATION_EXTENSION_RELOADED")
		else:
			print("InnerClassA:_notification what = unkonwn...")
		return

## InnerClassA のオブジェクトを複数保持する配列です。
var inner_class_a_objects: Array[InnerClassA] = []

## Object 派生のインナークラスを生成して格納した配列を消去した際にメモリーリークが発生しないことを検証するための関数です。
## 本関数を呼び出して実行を終了した後に、プロファイラのメモリ使用量の変化を確認します。
## print_orphan_nodes は　Node 派生クラスのオブジェクトのリークを調べられそう。
func test_object_array_memory_leak_1() -> void:
	print_debug("test_object_array_memory_leak_1 called")
	
	# すでに配列に要素があれば実行しません。
	if inner_class_a_objects.size() > 0:
		print_debug("test_object_array_memory_leak_1 : ner_class_a_objects.size() > 0")
		return

	# 生成するオブジェクトの個数を設定します。
	var numof_objects: int = 10000
	inner_class_a_objects.resize(numof_objects)
	# オブジェクトを生成して配列に格納します。
	for i in range(numof_objects):
		var obj: InnerClassA = InnerClassA.new()
		obj.id = i
		inner_class_a_objects[i] = obj
	# オブジェクトのインスタンスのデータを確認します。（最適化で作られない可能性を防ぐため）
	for i in range(numof_objects):
		print("inner_class_a_objects[", str(i), "].id = ", str(inner_class_a_objects[i].id))

	# 配列の要素を消去します。
	inner_class_a_objects.clear() # メモリリークが発生するかどうかを確認するメイン部分
	return

# Called when the node enters the scene tree for the first time.
func _ready():
	print("実行画面で Enter / Space キーを１度押してメモリーリークについてテストを行います。")
	print("モニタータブのメモリーや Object の要素をチェックして、初期に比べ終了時の使用量が増えていないか確認してください。")
	return

# Called every frame. 'delta' is the elapsed time since the previous frame.
func _process(_delta):
	# Enter / Space キーが押された場合、１回テストを行います。
	if Input.is_action_just_released("ui_accept"):
		test_object_array_memory_leak_1()
	return

extends Node2D

## new クラス関数による生成時、このオブジェクトが消去される際に
## 関数がどのタイミングで呼び出されるかを print 出力で確認するためのインナークラスです。
## test_study_inner_class1.gd で GUT によるテストでメモリリークがないかを確認します。
class InnerClassA extends Object:
	## インナークラスを作るために、メンバ変数を適当に持たせます。
	var id: int
	
	## コンストラクタの仮想関数です。
	func _init() -> void:
		print("InnerClassA:_init called")
		return
	
	## オブジェクトが消去される直前などに通知してくるイベント関数です。
	func _notification(what: int) -> void:
		print("InnerClassA:_notification called what = ", what)
		if what == NOTIFICATION_PREDELETE:	# 実質的なデストラクタ
			print("InnerClassA:_notification what = NOTIFICATION_PREDELETE")
		elif what == NOTIFICATION_POSTINITIALIZE:
			print("InnerClassA:_notification what = NOTIFICATION_POSTINITIALIZE")
		elif what == NOTIFICATION_EXTENSION_RELOADED:
			print("InnerClassA:_notification what = NOTIFICATION_EXTENSION_RELOADED")
		else:
			print("InnerClassA:_notification what = unkonwn...")
		return

## InnerClassA のオブジェクトを複数保持する配列です。
var inner_class_a_objects: Array[InnerClassA] = []

## Object 派生のインナークラスを生成して格納した配列を消去した際にメモリーリークが発生しないことを検証するための関数です。
## 本関数を呼び出して実行を終了した後に、プロファイラのメモリ使用量の変化を確認します。
## print_orphan_nodes は　Node 派生クラスのオブジェクトのリークを調べられそう。
func test_object_array_memory_leak_1() -> void:
	print_debug("test_object_array_memory_leak_1 called")
	
	# すでに配列に要素があれば実行しません。
	if inner_class_a_objects.size() > 0:
		print_debug("test_object_array_memory_leak_1 : ner_class_a_objects.size() > 0")
		return

	# 生成するオブジェクトの個数を設定します。
	var numof_objects: int = 10000
	inner_class_a_objects.resize(numof_objects)
	# オブジェクトを生成して配列に格納します。
	for i in range(numof_objects):
		var obj: InnerClassA = InnerClassA.new()
		obj.id = i
		inner_class_a_objects[i] = obj
	# オブジェクトのインスタンスのデータを確認します。（最適化で作られない可能性を防ぐため）
	for i in range(numof_objects):
		print("inner_class_a_objects[", str(i), "].id = ", str(inner_class_a_objects[i].id))

	# 配列の要素を消去する前に、その要素ごとに解放処理を行います。
	for i in range(numof_objects):
		inner_class_a_objects[i].free()

	# 配列の要素を消去します。
	inner_class_a_objects.clear() # メモリリークが発生するかどうかを確認するメイン部分
	return

# Called when the node enters the scene tree for the first time.
func _ready():
	print("実行画面で Enter / Space キーを１度押してメモリーリークについてテストを行います。")
	print("モニタータブのメモリーや Object の要素をチェックして、初期に比べ終了時の使用量が増えていないか確認してください。")
	return

# Called every frame. 'delta' is the elapsed time since the previous frame.
func _process(_delta):
	# Enter / Space キーが押された場合、１回テストを行います。
	if Input.is_action_just_released("ui_accept"):
		test_object_array_memory_leak_1()
	return

extends Node2D

## new クラス関数による生成時、このオブジェクトが消去される際に
## 関数がどのタイミングで呼び出されるかを print 出力で確認するためのインナークラスです。
## test_study_inner_class1.gd で GUT によるテストでメモリリークがないかを確認します。
class InnerClassA extends RefCounted:
	## インナークラスを作るために、メンバ変数を適当に持たせます。
	var id: int
	
	## コンストラクタの仮想関数です。
	func _init() -> void:
		print("InnerClassA:_init called")
		return
	
	## オブジェクトが消去される直前などに通知してくるイベント関数です。
	func _notification(what: int) -> void:
		print("InnerClassA:_notification called what = ", what)
		if what == NOTIFICATION_PREDELETE:	# 実質的なデストラクタ
			print("InnerClassA:_notification what = NOTIFICATION_PREDELETE")
		elif what == NOTIFICATION_POSTINITIALIZE:
			print("InnerClassA:_notification what = NOTIFICATION_POSTINITIALIZE")
		elif what == NOTIFICATION_EXTENSION_RELOADED:
			print("InnerClassA:_notification what = NOTIFICATION_EXTENSION_RELOADED")
		else:
			print("InnerClassA:_notification what = unkonwn...")
		return

## InnerClassA のオブジェクトを複数保持する配列です。
var inner_class_a_objects: Array[InnerClassA] = []

## Object 派生のインナークラスを生成して格納した配列を消去した際にメモリーリークが発生しないことを検証するための関数です。
## 本関数を呼び出して実行を終了した後に、プロファイラのメモリ使用量の変化を確認します。
## print_orphan_nodes は　Node 派生クラスのオブジェクトのリークを調べられそう。
func test_object_array_memory_leak_1() -> void:
	print_debug("test_object_array_memory_leak_1 called")
	
	# すでに配列に要素があれば実行しません。
	if inner_class_a_objects.size() > 0:
		print_debug("test_object_array_memory_leak_1 : ner_class_a_objects.size() > 0")
		return

	# 生成するオブジェクトの個数を設定します。
	var numof_objects: int = 10000
	inner_class_a_objects.resize(numof_objects)
	# オブジェクトを生成して配列に格納します。
	for i in range(numof_objects):
		var obj: InnerClassA = InnerClassA.new()
		obj.id = i
		inner_class_a_objects[i] = obj
	# オブジェクトのインスタンスのデータを確認します。（最適化で作られない可能性を防ぐため）
	for i in range(numof_objects):
		print("inner_class_a_objects[", str(i), "].id = ", str(inner_class_a_objects[i].id))

	# 配列の要素を消去する前に、その要素ごとに解放処理を行います。
	#for i in range(numof_objects):
		#inner_class_a_objects[i].free() # RefCounted 派生の際に呼ぶとエラーになります。

	# 配列の要素を消去します。
	inner_class_a_objects.clear() # メモリリークが発生するかどうかを確認するメイン部分
	return

# Called when the node enters the scene tree for the first time.
func _ready():
	print("実行画面で Enter / Space キーを１度押してメモリーリークについてテストを行います。")
	print("モニタータブのメモリーや Object の要素をチェックして、初期に比べ終了時の使用量が増えていないか確認してください。")
	return

# Called every frame. 'delta' is the elapsed time since the previous frame.
func _process(_delta):
	# Enter / Space キーが押された場合、１回テストを行います。
	if Input.is_action_just_released("ui_accept"):
		test_object_array_memory_leak_1()
	return