Merge pull request #191 from theludovyc/fix#88_save_load_thread

Draft, Fix#88 save load thread

Author: Jeremi360

Test/RakugoTest.gd

@@ -57,7 +57,7 @@ func assert_variable(var_name:String, var_type, value):
 func wait_character_variable_changed(char_tag:String, var_name:String, var_type, value):
 	yield(wait_signal("character_variable_changed", [char_tag, var_name, value]), "completed")
 
-	assert_variable(var_name, var_type, value)
+	assert_variable(char_tag+"."+var_name, var_type, value)
 
 func wait_variable_changed(var_name:String, var_type, value):
 	yield(wait_signal("variable_changed", [var_name, value]), "completed")

Test/TestRakugo/TestSaveLoad/TestSaveLoad.gd

@@ -1,7 +1,11 @@
-extends GutTest
+extends "res://Test/RakugoTest.gd"
+
+const file_path = "res://Test/TestRakugo/TestSaveLoad/TestSaveLoad.rk"
+
+var file_base_name = get_file_base_name(file_path)
 
 func before_all():
-	var save_folder = "user://saves/quick"
+	var save_folder = ProjectSettings.get_setting("addons/rakugo/save_folder")
 
 	var directory = Directory.new()
 
@@ -14,15 +18,43 @@ func before_all():
 		directory.remove(save_folder)
 
 func test_save_load():
+	watch_rakugo_signals()
+
 	Rakugo.set_variable("life", 5)
+
+	wait_variable_changed("life", TYPE_INT, 5)
 
 	Rakugo.define_character("Sy", "Sylvie")
 
 	Rakugo.set_variable("Sy.friendship", 3)
+
+	wait_character_variable_changed("Sy", "friendship", TYPE_INT, 3)
+
+	yield(wait_parse_and_execute_script(file_path), "completed")
+
+	yield(wait_say({}, "Hello, world !"), "completed")
+
+	assert_do_step()
+
+	yield(wait_say({}, "Save from here"), "completed")
 
 	Rakugo.save_game()
+
+	Rakugo.stop_last_script()
+
+	yield(wait_execute_script_finished(file_base_name), "completed")
 
 	Rakugo.load_game()
+
+	Rakugo.resume_loaded_script()
+
+	yield(wait_execute_script_start(file_base_name), "completed")
+
+	yield(wait_say({}, "Save from here"), "completed")
+
+	Rakugo.stop_last_script()
+
+	yield(wait_execute_script_finished(file_base_name), "completed")
 
 	assert_eq(Rakugo.get_variable("life"), 5)
 

Test/TestRakugo/TestSaveLoad/TestSaveLoad.rk

@@ -0,0 +1,2 @@
+"Hello, world !"
+"Save from here"

addons/Rakugo/Rakugo.gd

@@ -36,6 +36,9 @@ var waiting_ask_return := false setget , is_waiting_ask_return
 
 var waiting_menu_return := false setget , is_waiting_menu_return
 
+# when you load game to run last script
+var last_thread_datas:Dictionary
+
 onready var store_manager := StoreManager.new()
 onready var parser := Parser.new(store_manager)
 onready var executer := Executer.new(store_manager)
@@ -178,12 +181,16 @@ func _ready():
 
 
 func save_game(save_name: String = "quick"):
-	store_manager.save_game(save_name)
+	store_manager.save_game(executer.get_current_thread_datas(), save_name)
 
 
 func load_game(save_name := "quick"):
-	store_manager.load_game(save_name)
+	last_thread_datas = store_manager.load_game(save_name)
+	parse_script(last_thread_datas["path"])
 
+func resume_loaded_script():
+	if !last_thread_datas.empty():
+		executer.execute_script(last_thread_datas["file_base_name"], "", last_thread_datas["last_index"])
 
 # Parser
 func parse_script(file_name: String) -> int:

addons/Rakugo/lib/systems/Executer.gd

@@ -34,6 +34,14 @@ func _init(store_manager):
 	else:
 		push_error("execturer, VARIABLE_IN_STR compilation failed")
 
+func get_current_thread_datas() -> Dictionary:
+	if current_thread and current_thread.is_active():
+		var dico = threads[current_thread.get_id()]
+
+		return {"file_base_name":dico["file_base_name"], "last_index":dico["last_index"]}
+
+	return {}
+
 func stop_current_thread() -> int:
 	if current_thread and current_thread.is_active():
 		var dico = threads[current_thread.get_id()]
@@ -42,7 +50,7 @@ func stop_current_thread() -> int:
 		dico["semaphore"].post()
 	return OK
 
-func execute_script(script_name:String, label_name:String) -> int:
+func execute_script(script_name:String, label_name:String = "", index:int = 0) -> int:
 	stop_current_thread()
 
 	if store_manager.parsed_scripts.has(script_name):
@@ -52,7 +60,9 @@ func execute_script(script_name:String, label_name:String) -> int:
 
 		var dico = {"thread":current_thread, "semaphore":current_semaphore, "file_base_name":script_name, "stop":false}
 
-		if !label_name.empty():
+		if index > 0:
+			dico["last_index"] = index
+		elif !label_name.empty():
 			dico["label_name"] = label_name
 
 		if current_thread.start(self, "do_execute_script", dico) != OK:
@@ -101,8 +111,6 @@ func do_execute_script(parameters:Dictionary):
 	var file_base_name = parameters["file_base_name"]
 
 	Rakugo.send_execute_script_start(file_base_name)
-	
-	var index := 0
 
 	var script = store_manager.parsed_scripts[file_base_name]
 
@@ -111,17 +119,26 @@ func do_execute_script(parameters:Dictionary):
 	var labels = script["labels"]
 
 	var error = OK
+
+	var index := 0
+
+	if parameters.has("last_index"):
+		index = parameters["last_index"]
+	else:
+		parameters["last_index"] = 0
 
-	if parameters.has("label_name"):
-		var label = parameters["label_name"]
+		if parameters.has("label_name"):
+			var label = parameters["label_name"]
 
-		index = do_execute_jump(label, labels)
+			index = do_execute_jump(label, labels)
 
-		if index == -1:
-			parameters["error"] = jump_error + label
-			parameters["stop"] = true
+			if index == -1:
+				parameters["error"] = jump_error + label
+				parameters["stop"] = true
 
 	while !parameters["stop"] and index < parse_array.size():
+		parameters["last_index"] = index
+
 		var line:Array = parse_array[index]
 
 		var result = line[1]
@@ -212,12 +229,15 @@ func do_execute_script(parameters:Dictionary):
 				if menu_jumps.has(menu_jump_index):
 					var jump_label = menu_jumps[menu_jump_index]
 
-					index = do_execute_jump(jump_label, labels) - 1
+					index = do_execute_jump(jump_label, labels)
 
-					if index == -2:
+					if index == -1:
 						parameters["error"] = jump_error + jump_label
 						parameters["stop"] = true
 						break
+
+					# remove 1 because we add 1 at the end of the loop
+					index -= 1	
 				elif !(menu_jump_index in [0, menu_choices.size() - 1]):
 					parameters["error"] = "Executer::do_execute_script::MENU, menu_jump_index out of range: " + str(menu_jump_index) + " >= " + str(menu_choices.size())
 					parameters["stop"] = true

addons/Rakugo/lib/systems/Parser.gd

@@ -258,6 +258,6 @@ func parse_script(path:String) -> int:
 		if state == State.Menu and i == lines.size() - 1 and !menu_choices.empty():
 			parse_array.push_back(["MENU", current_menu_result, menu_choices])
 
-	store_manager.parsed_scripts[path.get_file().get_basename()] = {"parse_array":parse_array, "labels":labels}
+	store_manager.parsed_scripts[path.get_file().get_basename()] = {"path": path, "parse_array":parse_array, "labels":labels}
 
 	return OK

addons/Rakugo/lib/systems/StoreManager.gd

@@ -70,8 +70,7 @@ func save_json(path: String, data: Dictionary) -> int:
 	push_error("can't open file: " + path)
 	return ERR_FILE_CANT_OPEN
 
-
-func save_game(save_name: String = "quick") -> int:
+func save_game(thread_datas:Dictionary, save_name: String = "quick") -> int:
 	var save_folder = save_folder_path + "/" + save_name
 
 	var directory = Directory.new()
@@ -81,21 +80,29 @@ func save_game(save_name: String = "quick") -> int:
 			push_error("can't create dir: " + save_folder)
 			return FAILED
 
-	return save_json(save_folder + "/save.json", {"variables": variables, "characters": characters})
+	var sava_datas = {"variables": variables, "characters": characters}
+
+	if !thread_datas.empty():
+		thread_datas["path"] = parsed_scripts[thread_datas["file_base_name"]]["path"]
+
+		sava_datas["thread_datas"] = thread_datas
 
+	return save_json(save_folder + "/save.json", sava_datas)
 
-func load_game(save_name: String = "quick") -> int:
+
+func load_game(save_name: String = "quick") -> Dictionary:
 	var save_folder = save_folder_path + "/" + save_name
 
 	var directory = Directory.new()
 
 	if directory.dir_exists(save_folder):
 		var dico = load_json(save_folder + "/save.json")
 
-		variables = dico["variables"]
-		characters = dico["characters"]
+		if !dico.empty():
+			variables = dico["variables"]
+			characters = dico["characters"]
 
-		return OK
+			return dico.get("thread_datas", {})
 
 	push_error("save folder does not exist at path: " + save_folder)
-	return FAILED
+	return {}