cleaner getters and setters

Author: Qubus0

addons/mod_loader/_export_plugin/export_plugin.gd

@@ -3,13 +3,20 @@ extends EditorExportPlugin
 const REQUIRE_EXPLICIT_ADDITION := false
 const METHOD_PREFIX := "vanilla_"
 const HASH_COLLISION_ERROR :="MODDING EXPORT ERROR: Hash collision between %s and %s. The collision can be resolved by renaming one of the methods or changing their scripts path."
+
+static var regex_getter_setter: RegEx
+
 var hashmap := {}
 
+
 func _get_name() -> String:
 	return "Godot Mod Loader Export Plugin"
 
 func _export_begin(features: PackedStringArray, is_debug: bool, path: String, flags: int) -> void:
 	hashmap.clear()
+	regex_getter_setter = RegEx.new()
+	regex_getter_setter.compile("(.*?[sg]et\\s*=\\s*)(\\w+)(\\g<1>)?(\\g<2>)?")
+
 
 func _export_file(path: String, type: String, features: PackedStringArray) -> void:
 	if path.begins_with("res://addons") or path.begins_with("res://mods-unpacked"):
@@ -22,7 +29,7 @@ func _export_file(path: String, type: String, features: PackedStringArray) -> vo
 	var source_code := current_script.source_code
 	var source_code_additions := ""
 
-	#we need to stop all vanilla methods from forming inheritance chains 
+	#we need to stop all vanilla methods from forming inheritance chains
 	#since the generated methods will fulfill inheritance requirements
 	var class_prefix = str(hash(path))
 	var method_store: Array[String] = []
@@ -37,20 +44,26 @@ func _export_file(path: String, type: String, features: PackedStringArray) -> vo
 	#print("-------------------- Method List")
 	#print(JSON.stringify(current_script.get_script_method_list(), "\t"))
 	#print("--------------------")
+	#print(path.get_file())
+	var getters_setters := collect_getters_and_setters(source_code)
+
 	for method in current_script.get_script_method_list():
 		var method_first_line_start := get_index_at_method_start(method.name, source_code)
 		if method_first_line_start == -1 or method.name in method_store:
 			continue
-		
-		if not is_func_moddable(method.name, method_first_line_start, source_code):
+
+		if getters_setters.has(method.name):
+			continue
+
+		if not is_func_moddable(method_first_line_start, source_code):
 			continue
-			
+
 		#print(method.flags)
 		var type_string := get_return_type_string(method.return)
 		var is_static := true if method.flags == METHOD_FLAG_STATIC + METHOD_FLAG_NORMAL else false
 		var method_arg_string_with_defaults_and_types := get_function_parameters(method.name, source_code, is_static)
 		var method_arg_string_names_only := get_function_arg_name_string(method.args)
-		
+
 		var hash_before = ModLoaderMod.get_hook_hash(path, method.name, true)
 		var hash_after = ModLoaderMod.get_hook_hash(path, method.name, false)
 		var hash_before_data = [path, method.name,true]
@@ -61,7 +74,7 @@ func _export_file(path: String, type: String, features: PackedStringArray) -> vo
 			push_error(HASH_COLLISION_ERROR %[hashmap[hash_after], hash_after_data])
 		hashmap[hash_before] = hash_before_data
 		hashmap[hash_after] = hash_after_data
-	
+
 		var mod_loader_hook_string := get_mod_loader_hook(
 			method.name,
 			method_arg_string_names_only,
@@ -83,11 +96,11 @@ func _export_file(path: String, type: String, features: PackedStringArray) -> vo
 		method_store.push_back(method.name)
 		source_code = prefix_method_name(method.name, is_static, source_code, METHOD_PREFIX + class_prefix)
 		source_code_additions += "\n%s" % mod_loader_hook_string
-	
+
 	#if we have some additions to the code, append them at the end
 	if source_code_additions != "":
 		source_code = "%s\n%s\n%s" % [source_code,mod_loader_hooks_start_string, source_code_additions]
-	
+
 	skip()
 	add_file(path, source_code.to_utf8_buffer(), false)
 
@@ -112,7 +125,7 @@ static func get_function_arg_name_string(args: Array) -> String:
 			arg_string += args[x].name
 		else:
 			arg_string += "%s, " % args[x].name
-	
+
 	return arg_string
 
 
@@ -198,7 +211,7 @@ static func get_mod_loader_hook(
 	var self_string := "null" if is_static else "self"
 	var return_var := "var %s = " % "return_var" if not method_type.is_empty() or return_prop_usage == 131072 else ""
 	var method_return := "return %s" % "return_var" if not method_type.is_empty() or return_prop_usage == 131072 else ""
-	
+
 	return """
 {%STATIC%}func {%METHOD_NAME%}({%METHOD_PARAMS%}){%RETURN_TYPE_STRING%}:
 	ModLoaderMod.call_hooks({%SELF%}, [{%METHOD_ARGS%}], {%HOOK_ID_BEFORE%})
@@ -231,7 +244,7 @@ static func get_previous_line_to(text: String, index: int) -> String:
 
 	if start_index == 0:
 		return ""
-	
+
 	start_index -= 1
 
 	# Find the start of the previous line
@@ -241,9 +254,7 @@ static func get_previous_line_to(text: String, index: int) -> String:
 
 	return text.substr(start_index, end_index - start_index + 1)
 
-static func is_func_moddable(method_name, method_start_idx, text) -> bool:
-	if is_setter(method_name, text) or is_getter(method_name,text):
-		return false
+static func is_func_moddable(method_start_idx, text) -> bool:
 	if not REQUIRE_EXPLICIT_ADDITION:
 		return true
 	return get_previous_line_to(text, method_start_idx).contains("@moddable")
@@ -280,47 +291,27 @@ static func get_return_type_string(return_data: Dictionary) -> String:
 		return ""
 	var type_base
 	if return_data.has("class_name") and not str(return_data.class_name).is_empty():
-		type_base = str(return_data.class_name) 
+		type_base = str(return_data.class_name)
 	else:
 		type_base = type_string(return_data.type)
-		
+
 	var type_hint = "" if return_data.hint_string.is_empty() else ("[%s]" % return_data.hint_string)
 
 	return "%s%s" % [type_base, type_hint]
 
-static func is_setter(method_name: String, text: String, offset := 0) -> bool:
-	var pattern := "set\\s*=\\s*%s" % method_name
-	var regex := RegEx.new()
-	regex.compile(pattern)
 
-	var result := regex.search(text, offset)
-
-	if result:
-		var line_start_index := text.rfind("\n", result.get_start()) + 1
-		var line_start_string := text.substr(result.get_start(), result.get_start() - line_start_index)
-		if line_start_string.contains("#"):
-
-			return is_setter(method_name, text, result.get_end())
-
-		return true
-
-	return false
-
-
-static func is_getter(method_name: String, text: String, offset := 0) -> bool:
-	var pattern := "get\\s*=\\s*%s" % method_name
-	var regex := RegEx.new()
-	regex.compile(pattern)
-
-	var result := regex.search(text, offset)
-
-	if result:
-		var line_start_index := text.rfind("\n", result.get_start()) + 1
-		var line_start_string := text.substr(result.get_start(), result.get_start() - line_start_index)
-		if line_start_string.contains("#"):
-
-			return is_setter(method_name, text, result.get_end())
+static func collect_getters_and_setters(text: String) -> Dictionary:
+	var result := {}
+	# a valid match has 2 or 4 groups, split into the method names and the rest of the line
+	# (var example: set = )(example_setter)(, get = )(example_getter)
+	# if things between the names are empty or commented, exclude them
+	for mat in regex_getter_setter.search_all(text):
+		if mat.get_string(1).is_empty() or mat.get_string(1).contains("#"):
+			continue
+		result[mat.get_string(2)] = null
 
-		return true
+		if mat.get_string(3).is_empty() or mat.get_string(3).contains("#"):
+			continue
+		result[mat.get_string(4)] = null
 
-	return false
+	return result