godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

GDScript: Support `%` in shorthand for `get_node` 

The `%` is used in scene unique nodes. Now `%` can also be used instead
of `$` for the shorthand, besides being allowed generally anywhere in
the path as the prefix for a node name.
This commit is contained in:
George Marques 2022-05-26 12:56:39 -03:00
parent d81c5eab8c
commit eba3e0a9fc
No known key found for this signature in database
GPG Key ID: 046BD46A3201E43D
11 changed files with 182 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
editor/plugins/script_text_editor.cpp
View File

@ -1568,9 +1568,11 @@ void ScriptTextEditor::drop_data_fw(const Point2 &p_point, const Variant &p_data
continue;
}
bool is_unique = false;
String path;
if (node->is_unique_name_in_owner()) {
path = "%" + node->get_name();
path = node->get_name();
is_unique = true;
} else {
path = sn->get_path_to(node);
}
@ -1583,9 +1585,9 @@ void ScriptTextEditor::drop_data_fw(const Point2 &p_point, const Variant &p_data
String variable_name = String(node->get_name()).camelcase_to_underscore(true).validate_identifier();
if (use_type) {
text_to_drop += vformat("@onready var %s: %s = $%s\n", variable_name, node->get_class_name(), path);
text_to_drop += vformat("@onready var %s: %s = %s%s\n", variable_name, node->get_class_name(), is_unique ? "%" : "$", path);
} else {
text_to_drop += vformat("@onready var %s = $%s\n", variable_name, path);
text_to_drop += vformat("@onready var %s = %s%s\n", variable_name, is_unique ? "%" : "$", path);
}
}
} else {
@ -1600,19 +1602,22 @@ void ScriptTextEditor::drop_data_fw(const Point2 &p_point, const Variant &p_data
continue;
}
bool is_unique = false;
String path;
if (node->is_unique_name_in_owner()) {
path = "%" + node->get_name();
path = node->get_name();
is_unique = true;
} else {
path = sn->get_path_to(node);
}
for (const String &segment : path.split("/")) {
if (!segment.is_valid_identifier()) {
path = path.c_escape().quote(quote_style);
break;
}
}
text_to_drop += "$" + path;
text_to_drop += (is_unique ? "%" : "$") + path;
}
}

4
modules/gdscript/editor/gdscript_highlighter.cpp
View File

@ -387,9 +387,9 @@ Dictionary GDScriptSyntaxHighlighter::_get_line_syntax_highlighting_impl(int p_l
in_member_variable = false;
}
if (!in_node_path && in_region == -1 && str[j] == '$') {
if (!in_node_path && in_region == -1 && (str[j] == '$' || str[j] == '%')) {
in_node_path = true;
} else if (in_region != -1 || (is_a_symbol && str[j] != '/')) {
} else if (in_region != -1 || (is_a_symbol && str[j] != '/' && str[j] != '%')) {
in_node_path = false;
}

14
modules/gdscript/gdscript_compiler.cpp
View File

@ -667,20 +667,8 @@ GDScriptCodeGenerator::Address GDScriptCompiler::_parse_expression(CodeGen &code
case GDScriptParser::Node::GET_NODE: {
const GDScriptParser::GetNodeNode *get_node = static_cast<const GDScriptParser::GetNodeNode *>(p_expression);
String node_name;
if (get_node->string != nullptr) {
node_name += String(get_node->string->value);
} else {
for (int i = 0; i < get_node->chain.size(); i++) {
if (i > 0) {
node_name += "/";
}
node_name += get_node->chain[i]->name;
}
}
Vector<GDScriptCodeGenerator::Address> args;
args.push_back(codegen.add_constant(NodePath(node_name)));
args.push_back(codegen.add_constant(NodePath(get_node->full_path)));
GDScriptCodeGenerator::Address result = codegen.add_temporary(_gdtype_from_datatype(get_node->get_datatype()));

147
modules/gdscript/gdscript_parser.cpp
View File

@ -2824,51 +2824,97 @@ GDScriptParser::ExpressionNode *GDScriptParser::parse_call(ExpressionNode *p_pre
}
GDScriptParser::ExpressionNode *GDScriptParser::parse_get_node(ExpressionNode *p_previous_operand, bool p_can_assign) {
if (match(GDScriptTokenizer::Token::LITERAL)) {
if (previous.literal.get_type() != Variant::STRING) {
push_error(R"(Expect node path as string or identifier after "$".)");
return nullptr;
}
GetNodeNode *get_node = alloc_node<GetNodeNode>();
make_completion_context(COMPLETION_GET_NODE, get_node);
get_node->string = parse_literal();
return get_node;
} else if (current.is_node_name()) {
GetNodeNode *get_node = alloc_node<GetNodeNode>();
int chain_position = 0;
do {
make_completion_context(COMPLETION_GET_NODE, get_node, chain_position++);
if (!current.is_node_name()) {
push_error(R"(Expect node path after "/".)");
return nullptr;
}
advance();
IdentifierNode *identifier = alloc_node<IdentifierNode>();
identifier->name = previous.get_identifier();
get_node->chain.push_back(identifier);
} while (match(GDScriptTokenizer::Token::SLASH));
return get_node;
} else if (match(GDScriptTokenizer::Token::SLASH)) {
GetNodeNode *get_node = alloc_node<GetNodeNode>();
IdentifierNode *identifier_root = alloc_node<IdentifierNode>();
get_node->chain.push_back(identifier_root);
int chain_position = 0;
do {
make_completion_context(COMPLETION_GET_NODE, get_node, chain_position++);
if (!current.is_node_name()) {
push_error(R"(Expect node path after "/".)");
return nullptr;
}
advance();
IdentifierNode *identifier = alloc_node<IdentifierNode>();
identifier->name = previous.get_identifier();
get_node->chain.push_back(identifier);
} while (match(GDScriptTokenizer::Token::SLASH));
return get_node;
} else {
push_error(R"(Expect node path as string or identifier after "$".)");
if (!current.is_node_name() && !check(GDScriptTokenizer::Token::LITERAL) && !check(GDScriptTokenizer::Token::SLASH) && !check(GDScriptTokenizer::Token::PERCENT)) {
push_error(vformat(R"(Expected node path as string or identifier after "%s".)", previous.get_name()));
return nullptr;
}
if (check(GDScriptTokenizer::Token::LITERAL)) {
if (current.literal.get_type() != Variant::STRING) {
push_error(vformat(R"(Expected node path as string or identifier after "%s".)", previous.get_name()));
return nullptr;
}
}
GetNodeNode *get_node = alloc_node<GetNodeNode>();
// Store the last item in the path so the parser knows what to expect.
// Allow allows more specific error messages.
enum PathState {
PATH_STATE_START,
PATH_STATE_SLASH,
PATH_STATE_PERCENT,
PATH_STATE_NODE_NAME,
} path_state = PATH_STATE_START;
if (previous.type == GDScriptTokenizer::Token::DOLLAR) {
// Detect initial slash, which will be handled in the loop if it matches.
match(GDScriptTokenizer::Token::SLASH);
#ifdef DEBUG_ENABLED
} else {
get_node->use_dollar = false;
#endif
}
int context_argument = 0;
do {
if (previous.type == GDScriptTokenizer::Token::PERCENT) {
if (path_state != PATH_STATE_START && path_state != PATH_STATE_SLASH) {
push_error(R"("%" is only valid in the beginning of a node name (either after "$" or after "/"))");
return nullptr;
}
get_node->full_path += "%";
path_state = PATH_STATE_PERCENT;
} else if (previous.type == GDScriptTokenizer::Token::SLASH) {
if (path_state != PATH_STATE_START && path_state != PATH_STATE_NODE_NAME) {
push_error(R"("/" is only valid at the beginning of the path or after a node name.)");
return nullptr;
}
get_node->full_path += "/";
path_state = PATH_STATE_SLASH;
}
make_completion_context(COMPLETION_GET_NODE, get_node, context_argument++);
if (match(GDScriptTokenizer::Token::LITERAL)) {
if (previous.literal.get_type() != Variant::STRING) {
String previous_token;
switch (path_state) {
case PATH_STATE_START:
previous_token = "$";
break;
case PATH_STATE_PERCENT:
previous_token = "%";
break;
case PATH_STATE_SLASH:
previous_token = "/";
break;
default:
break;
}
push_error(vformat(R"(Expected node path as string or identifier after "%s".)", previous_token));
return nullptr;
}
get_node->full_path += previous.literal.operator String();
path_state = PATH_STATE_NODE_NAME;
} else if (current.is_node_name()) {
advance();
get_node->full_path += previous.get_identifier();
path_state = PATH_STATE_NODE_NAME;
} else if (!check(GDScriptTokenizer::Token::SLASH) && !check(GDScriptTokenizer::Token::PERCENT)) {
push_error(vformat(R"(Unexpected "%s" in node path.)", current.get_name()));
return nullptr;
}
} while (match(GDScriptTokenizer::Token::SLASH) || match(GDScriptTokenizer::Token::PERCENT));
return get_node;
}
GDScriptParser::ExpressionNode *GDScriptParser::parse_preload(ExpressionNode *p_previous_operand, bool p_can_assign) {
@ -3273,7 +3319,7 @@ GDScriptParser::ParseRule *GDScriptParser::get_rule(GDScriptTokenizer::Token::Ty
{ nullptr, &GDScriptParser::parse_binary_operator, PREC_FACTOR }, // STAR,
{ nullptr, &GDScriptParser::parse_binary_operator, PREC_POWER }, // STAR_STAR,
{ nullptr, &GDScriptParser::parse_binary_operator, PREC_FACTOR }, // SLASH,
{ nullptr, &GDScriptParser::parse_binary_operator, PREC_FACTOR }, // PERCENT,
{ &GDScriptParser::parse_get_node, &GDScriptParser::parse_binary_operator, PREC_FACTOR }, // PERCENT,
// Assignment
{ nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // EQUAL,
{ nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // PLUS_EQUAL,
@ -4253,17 +4299,10 @@ void GDScriptParser::TreePrinter::print_function(FunctionNode *p_function, const
}
void GDScriptParser::TreePrinter::print_get_node(GetNodeNode *p_get_node) {
push_text("$");
if (p_get_node->string != nullptr) {
print_literal(p_get_node->string);
} else {
for (int i = 0; i < p_get_node->chain.size(); i++) {
if (i > 0) {
push_text("/");
}
print_identifier(p_get_node->chain[i]);
}
if (p_get_node->use_dollar) {
push_text("$");
}
push_text(p_get_node->full_path);
}
void GDScriptParser::TreePrinter::print_identifier(IdentifierNode *p_identifier) {

6
modules/gdscript/gdscript_parser.h
View File

@ -749,8 +749,10 @@ public:
};
struct GetNodeNode : public ExpressionNode {
LiteralNode *string = nullptr;
Vector<IdentifierNode *> chain;
String full_path;
#ifdef DEBUG_ENABLED
bool use_dollar = true;
#endif
GetNodeNode() {
type = GET_NODE;

2
modules/gdscript/tests/scripts/parser/errors/dollar-assignment-bug-53696.out
View File

@ -1,2 +1,2 @@
GDTEST_PARSER_ERROR
Expect node path as string or identifier after "$".
Expected node path as string or identifier after "$".

2
modules/gdscript/tests/scripts/parser/errors/nothing_after_dollar.out
View File

@ -1,2 +1,2 @@
GDTEST_PARSER_ERROR
Expect node path as string or identifier after "$".
Expected node path as string or identifier after "$".

2
modules/gdscript/tests/scripts/parser/errors/wrong_value_after_dollar.out
View File

@ -1,2 +1,2 @@
GDTEST_PARSER_ERROR
Expect node path as string or identifier after "$".
Expected node path as string or identifier after "$".

2
modules/gdscript/tests/scripts/parser/errors/wrong_value_after_dollar_slash.out
View File

@ -1,2 +1,2 @@
GDTEST_PARSER_ERROR
Expect node path after "/".
Expected node path as string or identifier after "/".

49
modules/gdscript/tests/scripts/parser/features/dollar_and_percent_get_node.gd Normal file
View File

@ -0,0 +1,49 @@
extends Node
func test():
var child = Node.new()
child.name = "Child"
add_child(child)
child.owner = self
var hey = Node.new()
hey.name = "Hey"
child.add_child(hey)
hey.owner = self
hey.unique_name_in_owner = true
var fake_hey = Node.new()
fake_hey.name = "Hey"
add_child(fake_hey)
fake_hey.owner = self
var sub_child = Node.new()
sub_child.name = "SubChild"
hey.add_child(sub_child)
sub_child.owner = self
var howdy = Node.new()
howdy.name = "Howdy"
sub_child.add_child(howdy)
howdy.owner = self
howdy.unique_name_in_owner = true
print(hey == $Child/Hey)
print(howdy == $Child/Hey/SubChild/Howdy)
print(%Hey == hey)
print($%Hey == hey)
print(%"Hey" == hey)
print($"%Hey" == hey)
print($%"Hey" == hey)
print(%Hey/%Howdy == howdy)
print($%Hey/%Howdy == howdy)
print($"%Hey/%Howdy" == howdy)
print($"%Hey"/"%Howdy" == howdy)
print(%"Hey"/"%Howdy" == howdy)
print($%"Hey"/"%Howdy" == howdy)
print($"%Hey"/%"Howdy" == howdy)
print(%"Hey"/%"Howdy" == howdy)
print($%"Hey"/%"Howdy" == howdy)
print(%"Hey/%Howdy" == howdy)
print($%"Hey/%Howdy" == howdy)

19
modules/gdscript/tests/scripts/parser/features/dollar_and_percent_get_node.out Normal file
View File

@ -0,0 +1,19 @@
GDTEST_OK
true
true
true
true
true
true
true
true
true
true
true
true
true
true
true
true
true
true