Improve GDScript autocompletion for methods

Spartan322 · Nov 22, 2024 · ae853e1 · ae853e1
1 parent f952bfe
commit ae853e1
Show file tree

Hide file tree

Showing 52 changed files with 126 additions and 113 deletions.
diff --git a/modules/gdscript/gdscript_editor.cpp b/modules/gdscript/gdscript_editor.cpp
@@ -1139,10 +1139,12 @@ static void _find_identifiers_in_class(const GDScriptParser::ClassNode *p_class,
 							continue;
 						}
 						option = ScriptLanguage::CodeCompletionOption(member.function->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
-						if (member.function->parameters.size() > 0) {
+						if (member.function->parameters.size() > 0 || (member.function->info.flags & METHOD_FLAG_VARARG)) {
 							option.insert_text += "(";
+							option.display += U"(\u2026)";
 						} else {
 							option.insert_text += "()";
+							option.display += "()";
 						}
 						break;
 					case GDScriptParser::ClassNode::Member::SIGNAL:
@@ -1184,6 +1186,7 @@ static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base
 	if (!p_types_only && base_type.is_meta_type && base_type.kind != GDScriptParser::DataType::BUILTIN && base_type.kind != GDScriptParser::DataType::ENUM) {
 		ScriptLanguage::CodeCompletionOption option("new", ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, ScriptLanguage::LOCATION_LOCAL);
 		option.insert_text += "(";
+		option.display += U"(\u2026)";
 		r_result.insert(option.display, option);
 	}
 
@@ -1241,10 +1244,12 @@ static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base
 							}
 							int location = p_recursion_depth + _get_method_location(scr->get_class_name(), E.name);
 							ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
-							if (E.arguments.size()) {
+							if (E.arguments.size() || (E.flags & METHOD_FLAG_VARARG)) {
 								option.insert_text += "(";
+								option.display += U"(\u2026)";
 							} else {
 								option.insert_text += "()";
+								option.display += "()";
 							}
 							r_result.insert(option.display, option);
 						}
@@ -1327,10 +1332,12 @@ static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base
 					}
 					int location = p_recursion_depth + _get_method_location(type, E.name);
 					ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
-					if (E.arguments.size()) {
+					if (E.arguments.size() || (E.flags & METHOD_FLAG_VARARG)) {
 						option.insert_text += "(";
+						option.display += U"(\u2026)";
 					} else {
 						option.insert_text += "()";
+						option.display += "()";
 					}
 					r_result.insert(option.display, option);
 				}
@@ -1398,10 +1405,12 @@ static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base
 						continue;
 					}
 					ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
-					if (E.arguments.size()) {
+					if (E.arguments.size() || (E.flags & METHOD_FLAG_VARARG)) {
 						option.insert_text += "(";
+						option.display += U"(\u2026)";
 					} else {
 						option.insert_text += "()";
+						option.display += "()";
 					}
 					r_result.insert(option.display, option);
 				}
@@ -1433,8 +1442,10 @@ static void _find_identifiers(const GDScriptParser::CompletionContext &p_context
 		ScriptLanguage::CodeCompletionOption option(String(E), ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
 		if (function.arguments.size() || (function.flags & METHOD_FLAG_VARARG)) {
 			option.insert_text += "(";
+			option.display += U"(\u2026)";
 		} else {
 			option.insert_text += "()";
+			option.display += "()";
 		}
 		r_result.insert(option.display, option);
 	}
@@ -1481,6 +1492,7 @@ static void _find_identifiers(const GDScriptParser::CompletionContext &p_context
 	while (*kwa) {
 		ScriptLanguage::CodeCompletionOption option(*kwa, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
 		option.insert_text += "(";
+		option.display += U"(\u2026)";
 		r_result.insert(option.display, option);
 		kwa++;
 	}
@@ -1491,6 +1503,7 @@ static void _find_identifiers(const GDScriptParser::CompletionContext &p_context
 	for (List<StringName>::Element *E = utility_func_names.front(); E; E = E->next()) {
 		ScriptLanguage::CodeCompletionOption option(E->get(), ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
 		option.insert_text += "(";
+		option.display += U"(\u2026)"; // As all utility functions contain an argument or more, this is hardcoded here.
 		r_result.insert(option.display, option);
 	}
 

diff --git a/modules/gdscript/tests/scripts/completion/assignment_options/enum_attribute.cfg b/modules/gdscript/tests/scripts/completion/assignment_options/enum_attribute.cfg
@@ -1,6 +1,6 @@
 [output]
 include=[
-    {"display": "new"},
+    {"display": "new(…)"},
     {"display": "SIZE_EXPAND"},
     {"display": "SIZE_EXPAND_FILL"},
     {"display": "SIZE_FILL"},

diff --git a/modules/gdscript/tests/scripts/completion/assignment_options/enum_attribute_identifier.cfg b/modules/gdscript/tests/scripts/completion/assignment_options/enum_attribute_identifier.cfg
@@ -1,6 +1,6 @@
 [output]
 include=[
-    {"display": "new"},
+    {"display": "new(…)"},
     {"display": "SIZE_EXPAND"},
     {"display": "SIZE_EXPAND_FILL"},
     {"display": "SIZE_FILL"},

diff --git a/modules/gdscript/tests/scripts/completion/common/identifiers_in_call.cfg b/modules/gdscript/tests/scripts/completion/common/identifiers_in_call.cfg
@@ -2,22 +2,22 @@ scene="res://completion/get_node/get_node.tscn"
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 
     ; GDScript: class_a.notest.gd
     {"display": "property_of_a"},
-    {"display": "func_of_a"},
+    {"display": "func_of_a()"},
     {"display": "signal_of_a"},
 
     ; GDScript: identifiers.gd
     {"display": "test_signal_1"},
     {"display": "test_signal_2"},
     {"display": "test_var_1"},
     {"display": "test_var_2"},
-    {"display": "test_func_1"},
-    {"display": "test_func_2"},
+    {"display": "test_func_1(…)"},
+    {"display": "test_func_2(…)"},
     {"display": "test_parameter_1"},
     {"display": "test_parameter_2"},
     {"display": "local_test_var_1"},

diff --git a/modules/gdscript/tests/scripts/completion/common/identifiers_in_function_body.cfg b/modules/gdscript/tests/scripts/completion/common/identifiers_in_function_body.cfg
@@ -2,22 +2,22 @@ scene="res://completion/get_node/get_node.tscn"
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 
     ; GDScript: class_a.notest.gd
     {"display": "property_of_a"},
-    {"display": "func_of_a"},
+    {"display": "func_of_a()"},
     {"display": "signal_of_a"},
 
     ; GDScript: identifiers.gd
     {"display": "test_signal_1"},
     {"display": "test_signal_2"},
     {"display": "test_var_1"},
     {"display": "test_var_2"},
-    {"display": "test_func_1"},
-    {"display": "test_func_2"},
+    {"display": "test_func_1(…)"},
+    {"display": "test_func_2(…)"},
     {"display": "test_parameter_1"},
     {"display": "test_parameter_2"},
     {"display": "local_test_var_1"},

diff --git a/modules/gdscript/tests/scripts/completion/common/identifiers_in_unclosed_call.cfg b/modules/gdscript/tests/scripts/completion/common/identifiers_in_unclosed_call.cfg
@@ -2,22 +2,22 @@ scene="res://completion/get_node/get_node.tscn"
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 
     ; GDScript: class_a.notest.gd
     {"display": "property_of_a"},
-    {"display": "func_of_a"},
+    {"display": "func_of_a()"},
     {"display": "signal_of_a"},
 
     ; GDScript: identifiers.gd
     {"display": "test_signal_1"},
     {"display": "test_signal_2"},
     {"display": "test_var_1"},
     {"display": "test_var_2"},
-    {"display": "test_func_1"},
-    {"display": "test_func_2"},
+    {"display": "test_func_1(…)"},
+    {"display": "test_func_2(…)"},
     {"display": "test_parameter_1"},
     {"display": "test_parameter_2"},
     {"display": "local_test_var_1"},

diff --git a/modules/gdscript/tests/scripts/completion/common/no_completion_in_string.cfg b/modules/gdscript/tests/scripts/completion/common/no_completion_in_string.cfg
@@ -2,23 +2,23 @@ scene="res://completion/get_node/get_node.tscn"
 [output]
 exclude=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
 
     ; GDScript: class_a.notest.gd
     {"display": "property_of_a"},
-    {"display": "func_of_a"},
+    {"display": "func_of_a()"},
     {"display": "signal_of_a"},
 
     ; GDScript: no_completion_in_string.gd
     {"display": "test_signal_1"},
     {"display": "test_signal_2"},
     {"display": "test_var_1"},
     {"display": "test_var_2"},
-    {"display": "test_func_1"},
-    {"display": "test_func_2"},
+    {"display": "test_func_1(…)"},
+    {"display": "test_func_2(…)"},
     {"display": "test_parameter_1"},
     {"display": "test_parameter_2"},
     {"display": "local_test_var_1"},

diff --git a/modules/gdscript/tests/scripts/completion/common/self.cfg b/modules/gdscript/tests/scripts/completion/common/self.cfg
@@ -2,20 +2,20 @@ scene="res://completion/get_node/get_node.tscn"
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 
     ; GDScript: class_a.notest.gd
     {"display": "property_of_a"},
-    {"display": "func_of_a"},
+    {"display": "func_of_a()"},
     {"display": "signal_of_a"},
 
     ; GDScript: self.gd
     {"display": "test_signal_1"},
     {"display": "test_signal_2"},
     {"display": "test_var_1"},
     {"display": "test_var_2"},
-    {"display": "test_func_1"},
-    {"display": "test_func_2"},
+    {"display": "test_func_1(…)"},
+    {"display": "test_func_2(…)"},
 ]
diff --git a/modules/gdscript/tests/scripts/completion/get_node/literal/dollar.cfg b/modules/gdscript/tests/scripts/completion/get_node/literal/dollar.cfg
@@ -1,7 +1,7 @@
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 ]
diff --git a/modules/gdscript/tests/scripts/completion/get_node/literal/percent.cfg b/modules/gdscript/tests/scripts/completion/get_node/literal/percent.cfg
@@ -1,7 +1,7 @@
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 ]
diff --git a/modules/gdscript/tests/scripts/completion/get_node/literal_scene/dollar_class_scene.cfg b/modules/gdscript/tests/scripts/completion/get_node/literal_scene/dollar_class_scene.cfg
@@ -3,12 +3,12 @@ scene="res://completion/get_node/get_node.tscn"
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 
     ; GDScript: class_a.notest.gd
     {"display": "property_of_a"},
-    {"display": "func_of_a"},
+    {"display": "func_of_a()"},
     {"display": "signal_of_a"},
 ]
diff --git a/modules/gdscript/tests/scripts/completion/get_node/literal_scene/dollar_native_scene.cfg b/modules/gdscript/tests/scripts/completion/get_node/literal_scene/dollar_native_scene.cfg
@@ -3,12 +3,12 @@ scene="res://completion/get_node/get_node.tscn"
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 
     ; AnimationPlayer
     {"display": "autoplay"},
-    {"display": "play"},
+    {"display": "play(…)"},
     {"display": "animation_changed"},
 ]
diff --git a/modules/gdscript/tests/scripts/completion/get_node/literal_scene/percent_class_scene.cfg b/modules/gdscript/tests/scripts/completion/get_node/literal_scene/percent_class_scene.cfg
@@ -3,12 +3,12 @@ scene="res://completion/get_node/get_node.tscn"
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 
     ; GDScript: class_a.notest.gd
     {"display": "property_of_a"},
-    {"display": "func_of_a"},
+    {"display": "func_of_a()"},
     {"display": "signal_of_a"},
 ]
diff --git a/modules/gdscript/tests/scripts/completion/get_node/literal_scene/percent_native_scene.cfg b/modules/gdscript/tests/scripts/completion/get_node/literal_scene/percent_native_scene.cfg
@@ -3,12 +3,12 @@ scene="res://completion/get_node/get_node.tscn"
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 
     ; AnimationPlayer
     {"display": "autoplay"},
-    {"display": "play"},
+    {"display": "play(…)"},
     {"display": "animation_changed"},
 ]
diff --git a/modules/gdscript/tests/scripts/completion/get_node/local/local.cfg b/modules/gdscript/tests/scripts/completion/get_node/local/local.cfg
@@ -1,7 +1,7 @@
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 ]
diff --git a/modules/gdscript/tests/scripts/completion/get_node/local_infered/local_infered.cfg b/modules/gdscript/tests/scripts/completion/get_node/local_infered/local_infered.cfg
@@ -1,7 +1,7 @@
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 ]
diff --git a/...cript/tests/scripts/completion/get_node/local_infered_scene/class_local_infered_scene.cfg b/...cript/tests/scripts/completion/get_node/local_infered_scene/class_local_infered_scene.cfg
@@ -3,12 +3,12 @@ scene="res://completion/get_node/get_node.tscn"
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 
     ; GDScript: class_a.notest.gd
     {"display": "property_of_a"},
-    {"display": "func_of_a"},
+    {"display": "func_of_a()"},
     {"display": "signal_of_a"},
 ]
diff --git a/...ript/tests/scripts/completion/get_node/local_infered_scene/native_local_infered_scene.cfg b/...ript/tests/scripts/completion/get_node/local_infered_scene/native_local_infered_scene.cfg
@@ -3,12 +3,12 @@ scene="res://completion/get_node/get_node.tscn"
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 
     ; AnimationPlayer
     {"display": "autoplay"},
-    {"display": "play"},
+    {"display": "play(…)"},
     {"display": "animation_changed"},
 ]
diff --git a/modules/gdscript/tests/scripts/completion/get_node/local_scene/class_local_scene.cfg b/modules/gdscript/tests/scripts/completion/get_node/local_scene/class_local_scene.cfg
@@ -3,12 +3,12 @@ scene="res://completion/get_node/get_node.tscn"
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 
     ; GDScript: class_a.notest.gd
     {"display": "property_of_a"},
-    {"display": "func_of_a"},
+    {"display": "func_of_a()"},
     {"display": "signal_of_a"},
 ]
diff --git a/modules/gdscript/tests/scripts/completion/get_node/local_scene/native_local_scene.cfg b/modules/gdscript/tests/scripts/completion/get_node/local_scene/native_local_scene.cfg
@@ -3,12 +3,12 @@ scene="res://completion/get_node/get_node.tscn"
 [output]
 include=[
     ; Node
-    {"display": "add_child"},
+    {"display": "add_child(…)"},
     {"display": "owner"},
     {"display": "child_entered_tree"},
 
     ; AnimationPlayer
     {"display": "autoplay"},
-    {"display": "play"},
+    {"display": "play(…)"},
     {"display": "animation_changed"},
 ]