summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJuan Linietsky <reduzio@gmail.com>2022-03-28 13:31:32 +0200
committerGitHub <noreply@github.com>2022-03-28 13:31:32 +0200
commited14ff5a08e6fd47a09f43a7fef2364d1b42a7e8 (patch)
tree8b65b476fec3c896f79ebdc834009f23f6483eab
parent6b2481fcfee06c1c946c59cf3f9b21347573d339 (diff)
Revert "Sort autocomplete/code completion options in a better way"
-rw-r--r--core/object/script_language.h57
-rw-r--r--modules/gdscript/gdscript_editor.cpp141
2 files changed, 24 insertions, 174 deletions
diff --git a/core/object/script_language.h b/core/object/script_language.h
index 8f6ee90069..2122f785b6 100644
--- a/core/object/script_language.h
+++ b/core/object/script_language.h
@@ -233,14 +233,6 @@ struct ScriptCodeCompletionOption {
KIND_FILE_PATH,
KIND_PLAIN_TEXT,
};
-
- enum Location {
- LOCATION_LOCAL = 0,
- LOCATION_PARENT_MASK = (1 << 8),
- LOCATION_OTHER_USER_CODE = (1 << 9),
- LOCATION_OTHER = (1 << 10),
- };
-
Kind kind = KIND_PLAIN_TEXT;
String display;
String insert_text;
@@ -248,60 +240,13 @@ struct ScriptCodeCompletionOption {
RES icon;
Variant default_value;
Vector<Pair<int, int>> matches;
- int location = LOCATION_OTHER;
ScriptCodeCompletionOption() {}
- ScriptCodeCompletionOption(const String &p_text, Kind p_kind, int p_location = LOCATION_OTHER) {
+ ScriptCodeCompletionOption(const String &p_text, Kind p_kind) {
display = p_text;
insert_text = p_text;
kind = p_kind;
- location = p_location;
- }
-};
-
-const int KIND_COUNT = 10;
-const ScriptCodeCompletionOption::Kind KIND_SORT_ORDER[KIND_COUNT] = {
- ScriptCodeCompletionOption::Kind::KIND_VARIABLE,
- ScriptCodeCompletionOption::Kind::KIND_MEMBER,
- ScriptCodeCompletionOption::Kind::KIND_FUNCTION,
- ScriptCodeCompletionOption::Kind::KIND_ENUM,
- ScriptCodeCompletionOption::Kind::KIND_SIGNAL,
- ScriptCodeCompletionOption::Kind::KIND_CONSTANT,
- ScriptCodeCompletionOption::Kind::KIND_CLASS,
- ScriptCodeCompletionOption::Kind::KIND_NODE_PATH,
- ScriptCodeCompletionOption::Kind::KIND_FILE_PATH,
- ScriptCodeCompletionOption::Kind::KIND_PLAIN_TEXT,
-};
-
-struct ScriptCodeCompletionOptionCompare {
- _FORCE_INLINE_ bool operator()(const ScriptCodeCompletionOption &l, const ScriptCodeCompletionOption &r) const {
- if (l.location == r.location) {
- // If locations are same, sort on kind
- if (l.kind == r.kind) {
- // If kinds are same, sort alphanumeric
- return l.display < r.display;
- }
-
- // Sort kinds based on the const sorting array defined above. Lower index = higher priority.
- int l_index = -1;
- int r_index = -1;
- for (int i = 0; i < KIND_COUNT; i++) {
- const ScriptCodeCompletionOption::Kind kind = KIND_SORT_ORDER[i];
- l_index = kind == l.kind ? i : l_index;
- r_index = kind == r.kind ? i : r_index;
-
- if (l_index != -1 && r_index != -1) {
- return l_index < r_index;
- }
- }
-
- // This return should never be hit unless something goes wrong.
- // l and r should always have a Kind which is in the sort order array.
- return l.display < r.display;
- }
-
- return l.location < r.location;
}
};
diff --git a/modules/gdscript/gdscript_editor.cpp b/modules/gdscript/gdscript_editor.cpp
index 2cc178edc8..c06137c3cc 100644
--- a/modules/gdscript/gdscript_editor.cpp
+++ b/modules/gdscript/gdscript_editor.cpp
@@ -490,89 +490,6 @@ struct GDScriptCompletionIdentifier {
const GDScriptParser::ExpressionNode *assigned_expression = nullptr;
};
-// LOCATION METHODS
-// These methods are used to populate the `ScriptCodeCompletionOption::location` integer.
-// For these methods, the location is based on the depth in the inheritance chain that the property
-// appears. For example, if you are completing code in a class that inherits Node2D, a property found on Node2D
-// will have a "better" (lower) location "score" than a property that is found on CanvasItem.
-
-static int _get_property_location(StringName p_class, StringName p_property) {
- if (!ClassDB::has_property(p_class, p_property)) {
- return ScriptCodeCompletionOption::LOCATION_OTHER;
- }
-
- int depth = 0;
- StringName class_test = p_class;
- while (class_test && !ClassDB::has_property(class_test, p_property, true)) {
- class_test = ClassDB::get_parent_class(class_test);
- depth++;
- }
-
- return depth | ScriptCodeCompletionOption::LOCATION_PARENT_MASK;
-}
-
-static int _get_constant_location(StringName p_class, StringName p_constant) {
- if (!ClassDB::has_integer_constant(p_class, p_constant)) {
- return ScriptCodeCompletionOption::LOCATION_OTHER;
- }
-
- int depth = 0;
- StringName class_test = p_class;
- while (class_test && !ClassDB::has_integer_constant(class_test, p_constant, true)) {
- class_test = ClassDB::get_parent_class(class_test);
- depth++;
- }
-
- return depth | ScriptCodeCompletionOption::LOCATION_PARENT_MASK;
-}
-
-static int _get_signal_location(StringName p_class, StringName p_signal) {
- if (!ClassDB::has_signal(p_class, p_signal)) {
- return ScriptCodeCompletionOption::LOCATION_OTHER;
- }
-
- int depth = 0;
- StringName class_test = p_class;
- while (class_test && !ClassDB::has_signal(class_test, p_signal, true)) {
- class_test = ClassDB::get_parent_class(class_test);
- depth++;
- }
-
- return depth | ScriptCodeCompletionOption::LOCATION_PARENT_MASK;
-}
-
-static int _get_method_location(StringName p_class, StringName p_method) {
- if (!ClassDB::has_method(p_class, p_method)) {
- return ScriptCodeCompletionOption::LOCATION_OTHER;
- }
-
- int depth = 0;
- StringName class_test = p_class;
- while (class_test && !ClassDB::has_method(class_test, p_method, true)) {
- class_test = ClassDB::get_parent_class(class_test);
- depth++;
- }
-
- return depth | ScriptCodeCompletionOption::LOCATION_PARENT_MASK;
-}
-
-static int _get_enum_constant_location(StringName p_class, StringName p_enum_constant) {
- if (!ClassDB::get_integer_constant_enum(p_class, p_enum_constant)) {
- return ScriptCodeCompletionOption::LOCATION_OTHER;
- }
-
- int depth = 0;
- StringName class_test = p_class;
- while (class_test && !ClassDB::get_integer_constant_enum(class_test, p_enum_constant, true)) {
- class_test = ClassDB::get_parent_class(class_test);
- depth++;
- }
-
- return depth | ScriptCodeCompletionOption::LOCATION_PARENT_MASK;
-}
-
-// END LOCATION METHODS
-
static String _get_visual_datatype(const PropertyInfo &p_info, bool p_is_arg = true) {
if (p_info.usage & PROPERTY_USAGE_CLASS_IS_ENUM) {
String enum_name = p_info.class_name;
@@ -809,18 +726,18 @@ static void _list_available_types(bool p_inherit_only, GDScriptParser::Completio
const GDScriptParser::ClassNode::Member &member = current->members[i];
switch (member.type) {
case GDScriptParser::ClassNode::Member::CLASS: {
- ScriptCodeCompletionOption option(member.m_class->identifier->name, ScriptCodeCompletionOption::KIND_CLASS, ScriptCodeCompletionOption::LOCATION_LOCAL);
+ ScriptCodeCompletionOption option(member.m_class->identifier->name, ScriptCodeCompletionOption::KIND_CLASS);
r_result.insert(option.display, option);
} break;
case GDScriptParser::ClassNode::Member::ENUM: {
if (!p_inherit_only) {
- ScriptCodeCompletionOption option(member.m_enum->identifier->name, ScriptCodeCompletionOption::KIND_ENUM, ScriptCodeCompletionOption::LOCATION_LOCAL);
+ ScriptCodeCompletionOption option(member.m_enum->identifier->name, ScriptCodeCompletionOption::KIND_ENUM);
r_result.insert(option.display, option);
}
} break;
case GDScriptParser::ClassNode::Member::CONSTANT: {
if (member.constant->get_datatype().is_meta_type && p_context.current_class->outer != nullptr) {
- ScriptCodeCompletionOption option(member.constant->identifier->name, ScriptCodeCompletionOption::KIND_CLASS, ScriptCodeCompletionOption::LOCATION_LOCAL);
+ ScriptCodeCompletionOption option(member.constant->identifier->name, ScriptCodeCompletionOption::KIND_CLASS);
r_result.insert(option.display, option);
}
} break;
@@ -836,7 +753,7 @@ static void _list_available_types(bool p_inherit_only, GDScriptParser::Completio
List<StringName> global_classes;
ScriptServer::get_global_class_list(&global_classes);
for (const StringName &E : global_classes) {
- ScriptCodeCompletionOption option(E, ScriptCodeCompletionOption::KIND_CLASS, ScriptCodeCompletionOption::LOCATION_OTHER_USER_CODE);
+ ScriptCodeCompletionOption option(E, ScriptCodeCompletionOption::KIND_CLASS);
r_result.insert(option.display, option);
}
@@ -847,7 +764,7 @@ static void _list_available_types(bool p_inherit_only, GDScriptParser::Completio
if (!info.is_singleton || info.path.get_extension().to_lower() != "gd") {
continue;
}
- ScriptCodeCompletionOption option(info.name, ScriptCodeCompletionOption::KIND_CLASS, ScriptCodeCompletionOption::LOCATION_OTHER_USER_CODE);
+ ScriptCodeCompletionOption option(info.name, ScriptCodeCompletionOption::KIND_CLASS);
r_result.insert(option.display, option);
}
}
@@ -856,10 +773,10 @@ static void _find_identifiers_in_suite(const GDScriptParser::SuiteNode *p_suite,
for (int i = 0; i < p_suite->locals.size(); i++) {
ScriptCodeCompletionOption option;
if (p_suite->locals[i].type == GDScriptParser::SuiteNode::Local::CONSTANT) {
- option = ScriptCodeCompletionOption(p_suite->locals[i].name, ScriptCodeCompletionOption::KIND_CONSTANT, ScriptCodeCompletionOption::LOCATION_LOCAL);
+ option = ScriptCodeCompletionOption(p_suite->locals[i].name, ScriptCodeCompletionOption::KIND_CONSTANT);
option.default_value = p_suite->locals[i].constant->initializer->reduced_value;
} else {
- option = ScriptCodeCompletionOption(p_suite->locals[i].name, ScriptCodeCompletionOption::KIND_VARIABLE, ScriptCodeCompletionOption::LOCATION_LOCAL);
+ option = ScriptCodeCompletionOption(p_suite->locals[i].name, ScriptCodeCompletionOption::KIND_VARIABLE);
}
r_result.insert(option.display, option);
}
@@ -876,10 +793,8 @@ static void _find_identifiers_in_class(const GDScriptParser::ClassNode *p_class,
if (!p_parent_only) {
bool outer = false;
const GDScriptParser::ClassNode *clss = p_class;
- int classes_processed = 0;
while (clss) {
for (int i = 0; i < clss->members.size(); i++) {
- const int location = (classes_processed + p_recursion_depth) | ScriptCodeCompletionOption::LOCATION_PARENT_MASK;
const GDScriptParser::ClassNode::Member &member = clss->members[i];
ScriptCodeCompletionOption option;
switch (member.type) {
@@ -887,7 +802,7 @@ static void _find_identifiers_in_class(const GDScriptParser::ClassNode *p_class,
if (p_only_functions || outer || (p_static)) {
continue;
}
- option = ScriptCodeCompletionOption(member.variable->identifier->name, ScriptCodeCompletionOption::KIND_MEMBER, location);
+ option = ScriptCodeCompletionOption(member.variable->identifier->name, ScriptCodeCompletionOption::KIND_MEMBER);
break;
case GDScriptParser::ClassNode::Member::CONSTANT:
if (p_only_functions) {
@@ -896,7 +811,7 @@ static void _find_identifiers_in_class(const GDScriptParser::ClassNode *p_class,
if (r_result.has(member.constant->identifier->name)) {
continue;
}
- option = ScriptCodeCompletionOption(member.constant->identifier->name, ScriptCodeCompletionOption::KIND_CONSTANT, location);
+ option = ScriptCodeCompletionOption(member.constant->identifier->name, ScriptCodeCompletionOption::KIND_CONSTANT);
if (member.constant->initializer) {
option.default_value = member.constant->initializer->reduced_value;
}
@@ -905,25 +820,25 @@ static void _find_identifiers_in_class(const GDScriptParser::ClassNode *p_class,
if (p_only_functions) {
continue;
}
- option = ScriptCodeCompletionOption(member.m_class->identifier->name, ScriptCodeCompletionOption::KIND_CLASS, location);
+ option = ScriptCodeCompletionOption(member.m_class->identifier->name, ScriptCodeCompletionOption::KIND_CLASS);
break;
case GDScriptParser::ClassNode::Member::ENUM_VALUE:
if (p_only_functions) {
continue;
}
- option = ScriptCodeCompletionOption(member.enum_value.identifier->name, ScriptCodeCompletionOption::KIND_CONSTANT, location);
+ option = ScriptCodeCompletionOption(member.enum_value.identifier->name, ScriptCodeCompletionOption::KIND_CONSTANT);
break;
case GDScriptParser::ClassNode::Member::ENUM:
if (p_only_functions) {
continue;
}
- option = ScriptCodeCompletionOption(member.m_enum->identifier->name, ScriptCodeCompletionOption::KIND_ENUM, location);
+ option = ScriptCodeCompletionOption(member.m_enum->identifier->name, ScriptCodeCompletionOption::KIND_ENUM);
break;
case GDScriptParser::ClassNode::Member::FUNCTION:
if (outer || (p_static && !member.function->is_static) || member.function->identifier->name.operator String().begins_with("@")) {
continue;
}
- option = ScriptCodeCompletionOption(member.function->identifier->name, ScriptCodeCompletionOption::KIND_FUNCTION, location);
+ option = ScriptCodeCompletionOption(member.function->identifier->name, ScriptCodeCompletionOption::KIND_FUNCTION);
if (member.function->parameters.size() > 0) {
option.insert_text += "(";
} else {
@@ -934,7 +849,7 @@ static void _find_identifiers_in_class(const GDScriptParser::ClassNode *p_class,
if (p_only_functions || outer) {
continue;
}
- option = ScriptCodeCompletionOption(member.signal->identifier->name, ScriptCodeCompletionOption::KIND_SIGNAL, location);
+ option = ScriptCodeCompletionOption(member.signal->identifier->name, ScriptCodeCompletionOption::KIND_SIGNAL);
break;
case GDScriptParser::ClassNode::Member::UNDEFINED:
break;
@@ -943,7 +858,6 @@ static void _find_identifiers_in_class(const GDScriptParser::ClassNode *p_class,
}
outer = true;
clss = clss->outer;
- classes_processed++;
}
}
@@ -982,24 +896,21 @@ static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base
List<PropertyInfo> members;
scr->get_script_property_list(&members);
for (const PropertyInfo &E : members) {
- int location = p_recursion_depth + _get_property_location(scr->get_class_name(), E.class_name);
- ScriptCodeCompletionOption option(E.name, ScriptCodeCompletionOption::KIND_MEMBER, location);
+ ScriptCodeCompletionOption option(E.name, ScriptCodeCompletionOption::KIND_MEMBER);
r_result.insert(option.display, option);
}
}
Map<StringName, Variant> constants;
scr->get_constants(&constants);
for (const KeyValue<StringName, Variant> &E : constants) {
- int location = p_recursion_depth + _get_constant_location(scr->get_class_name(), E.key);
- ScriptCodeCompletionOption option(E.key.operator String(), ScriptCodeCompletionOption::KIND_CONSTANT, location);
+ ScriptCodeCompletionOption option(E.key.operator String(), ScriptCodeCompletionOption::KIND_CONSTANT);
r_result.insert(option.display, option);
}
List<MethodInfo> signals;
scr->get_script_signal_list(&signals);
for (const MethodInfo &E : signals) {
- int location = p_recursion_depth + _get_signal_location(scr->get_class_name(), E.name);
- ScriptCodeCompletionOption option(E.name, ScriptCodeCompletionOption::KIND_SIGNAL, location);
+ ScriptCodeCompletionOption option(E.name, ScriptCodeCompletionOption::KIND_SIGNAL);
r_result.insert(option.display, option);
}
}
@@ -1010,8 +921,7 @@ static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base
if (E.name.begins_with("@")) {
continue;
}
- int location = p_recursion_depth + _get_method_location(scr->get_class_name(), E.name);
- ScriptCodeCompletionOption option(E.name, ScriptCodeCompletionOption::KIND_FUNCTION, location);
+ ScriptCodeCompletionOption option(E.name, ScriptCodeCompletionOption::KIND_FUNCTION);
if (E.arguments.size()) {
option.insert_text += "(";
} else {
@@ -1041,8 +951,7 @@ static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base
List<String> constants;
ClassDB::get_integer_constant_list(type, &constants);
for (const String &E : constants) {
- int location = p_recursion_depth + _get_constant_location(type, StringName(E));
- ScriptCodeCompletionOption option(E, ScriptCodeCompletionOption::KIND_CONSTANT, location);
+ ScriptCodeCompletionOption option(E, ScriptCodeCompletionOption::KIND_CONSTANT);
r_result.insert(option.display, option);
}
@@ -1056,8 +965,7 @@ static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base
if (E.name.contains("/")) {
continue;
}
- int location = p_recursion_depth + _get_property_location(type, E.class_name);
- ScriptCodeCompletionOption option(E.name, ScriptCodeCompletionOption::KIND_MEMBER, location);
+ ScriptCodeCompletionOption option(E.name, ScriptCodeCompletionOption::KIND_MEMBER);
r_result.insert(option.display, option);
}
}
@@ -1070,8 +978,7 @@ static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base
if (E.name.begins_with("_")) {
continue;
}
- int location = p_recursion_depth + _get_method_location(type, E.name);
- ScriptCodeCompletionOption option(E.name, ScriptCodeCompletionOption::KIND_FUNCTION, location);
+ ScriptCodeCompletionOption option(E.name, ScriptCodeCompletionOption::KIND_FUNCTION);
if (E.arguments.size()) {
option.insert_text += "(";
} else {
@@ -1080,6 +987,7 @@ static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base
r_result.insert(option.display, option);
}
}
+
return;
} break;
case GDScriptParser::DataType::BUILTIN: {
@@ -2339,8 +2247,7 @@ static void _find_enumeration_candidates(GDScriptParser::CompletionContext &p_co
ClassDB::get_enum_constants(class_name, enum_name, &enum_constants);
for (const StringName &E : enum_constants) {
String candidate = class_name + "." + E;
- int location = _get_enum_constant_location(class_name, E);
- ScriptCodeCompletionOption option(candidate, ScriptCodeCompletionOption::KIND_ENUM, location);
+ ScriptCodeCompletionOption option(candidate, ScriptCodeCompletionOption::KIND_ENUM);
r_result.insert(option.display, option);
}
}
@@ -2855,8 +2762,6 @@ static void _find_call_arguments(GDScriptParser::CompletionContext &p_context, c
r_options->push_back(E.value);
}
- r_options->sort_custom_inplace<ScriptCodeCompletionOptionCompare>();
-
return OK;
}