Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GDScript: Improve highlighting of types #82516

Merged
merged 1 commit into from
Oct 3, 2023
Merged

GDScript: Improve highlighting of types #82516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions modules/gdscript/editor/gdscript_highlighter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@ Dictionary GDScriptSyntaxHighlighter::_get_line_syntax_highlighting_impl(int p_l

if (str[k] == '(') {
in_function_name = true;
} else if (prev_text == GDScriptTokenizer::get_token_name(GDScriptTokenizer::Token::VAR)) {
} else if (prev_text == GDScriptTokenizer::get_token_name(GDScriptTokenizer::Token::VAR) || prev_text == GDScriptTokenizer::get_token_name(GDScriptTokenizer::Token::FOR)) {
in_variable_declaration = true;
}

Expand Down Expand Up @@ -480,7 +480,7 @@ Dictionary GDScriptSyntaxHighlighter::_get_line_syntax_highlighting_impl(int p_l
in_function_args = false;
}

if (expect_type && (prev_is_char || str[j] == '=') && str[j] != '[') {
if (expect_type && (prev_is_char || str[j] == '=') && str[j] != '[' && str[j] != '.') {
expect_type = false;
}

Expand Down Expand Up @@ -562,16 +562,11 @@ Dictionary GDScriptSyntaxHighlighter::_get_line_syntax_highlighting_impl(int p_l
} else if (in_keyword) {
next_type = KEYWORD;
color = keyword_color;
} else if (in_member_variable) {
next_type = MEMBER;
color = member_color;
} else if (in_signal_declaration) {
next_type = SIGNAL;

color = member_color;
} else if (in_function_name) {
next_type = FUNCTION;

if (!in_lambda && prev_text == GDScriptTokenizer::get_token_name(GDScriptTokenizer::Token::FUNC)) {
color = function_definition_color;
} else {
Expand All @@ -586,6 +581,9 @@ Dictionary GDScriptSyntaxHighlighter::_get_line_syntax_highlighting_impl(int p_l
} else if (expect_type) {
next_type = TYPE;
color = type_color;
} else if (in_member_variable) {
next_type = MEMBER;
color = member_color;
} else {
next_type = IDENTIFIER;
}
Expand Down Expand Up @@ -683,6 +681,12 @@ void GDScriptSyntaxHighlighter::_update_cache() {
for (const String &E : core_types) {
class_names[StringName(E)] = basetype_color;
}
class_names[SNAME("Variant")] = basetype_color;
class_names[SNAME("void")] = basetype_color;
// `get_core_type_words()` doesn't return primitive types.
class_names[SNAME("bool")] = basetype_color;
class_names[SNAME("int")] = basetype_color;
class_names[SNAME("float")] = basetype_color;

/* Reserved words. */
const Color keyword_color = EDITOR_GET("text_editor/theme/highlighting/keyword_color");
Expand All @@ -697,6 +701,10 @@ void GDScriptSyntaxHighlighter::_update_cache() {
}
}

// Highlight `set` and `get` as "keywords" with the function color to avoid conflicts with method calls.
reserved_keywords[SNAME("set")] = function_color;
reserved_keywords[SNAME("get")] = function_color;

/* Global functions. */
List<StringName> global_function_list;
GDScriptUtilityFunctions::get_function_list(&global_function_list);
Expand Down
98 changes: 45 additions & 53 deletions modules/gdscript/gdscript.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2368,62 +2368,60 @@ void GDScriptLanguage::frame() {

/* EDITOR FUNCTIONS */
void GDScriptLanguage::get_reserved_words(List<String> *p_words) const {
// TODO: Add annotations here?
// Please keep alphabetical order within categories.
static const char *_reserved_words[] = {
// operators
// Control flow.
dalexeev marked this conversation as resolved.
Show resolved Hide resolved
"break",
"continue",
"elif",
"else",
"for",
"if",
"match",
"pass",
"return",
"when",
"while",
// Declarations.
"class",
"class_name",
"const",
"enum",
"extends",
"func",
"namespace", // Reserved for potential future use.
"signal",
"static",
"trait", // Reserved for potential future use.
"var",
// Other keywords.
"await",
"breakpoint",
"self",
"super",
"yield", // Reserved for potential future use.
// Operators.
"and",
"as",
"in",
"is",
"not",
"or",
// types and values
// Special values (tokenizer treats them as literals, not as tokens).
"false",
"float",
"int",
"bool",
"null",
"PI",
"TAU",
"true",
// Constants.
"INF",
"NAN",
"self",
"true",
"void",
// functions
"as",
"PI",
"TAU",
// Functions (highlighter uses global function color instead).
"assert",
"await",
"breakpoint",
"class",
"class_name",
"extends",
"is",
"func",
"preload",
"signal",
"super",
// var
"const",
"enum",
"static",
"var",
// control flow
"break",
"continue",
"if",
"elif",
"else",
"for",
"pass",
"return",
"match",
"while",
"when",
// These keywords are not implemented currently, but reserved for (potential) future use.
// We highlight them as keywords to make errors easier to understand.
"trait",
"namespace",
"yield",
nullptr
// Types (highlighter uses type color instead).
"void",
nullptr,
dalexeev marked this conversation as resolved.
Show resolved Hide resolved
};

const char **w = _reserved_words;
Expand All @@ -2432,22 +2430,16 @@ void GDScriptLanguage::get_reserved_words(List<String> *p_words) const {
p_words->push_back(*w);
w++;
}

List<StringName> functions;
GDScriptUtilityFunctions::get_function_list(&functions);

for (const StringName &E : functions) {
p_words->push_back(String(E));
}
dalexeev marked this conversation as resolved.
Show resolved Hide resolved
}

bool GDScriptLanguage::is_control_flow_keyword(String p_keyword) const {
// Please keep alphabetical order.
return p_keyword == "break" ||
p_keyword == "continue" ||
p_keyword == "elif" ||
p_keyword == "else" ||
p_keyword == "if" ||
p_keyword == "for" ||
p_keyword == "if" ||
p_keyword == "match" ||
p_keyword == "pass" ||
p_keyword == "return" ||
Expand Down
6 changes: 6 additions & 0 deletions modules/gdscript/gdscript_editor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3396,6 +3396,12 @@ ::Error GDScriptLanguage::lookup_code(const String &p_code, const String &p_symb
}
}

if ("Variant" == p_symbol) {
r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
r_result.class_name = "Variant";
return OK;
}

if ("PI" == p_symbol || "TAU" == p_symbol || "INF" == p_symbol || "NAN" == p_symbol) {
r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
r_result.class_name = "@GDScript";
Expand Down