Skip to content

Restore support for parsing Variant::NIL and handling related cases in VariantParser #1276

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

Merged
Arctis-Fireblight merged 1 commit into from
Jun 22, 2026
+115 −0
Merged

Restore support for parsing Variant::NIL and handling related cases in VariantParser #1276

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
36 changes: 36 additions & 0 deletions core/variant/variant_parser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -714,6 +714,42 @@ Error VariantParser::parse_value(Token &token, Variant &value, Stream *p_stream,
value = -Math::INF;
} else if (id == "nan") {
value = Math::NaN;
} else if (id == "Variant") {
Error err = get_token(p_stream, token, line, r_err_str);
if (err) {
return err;
}
Comment on lines +718 to +721

@VictorSohier VictorSohier Jun 17, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's moments like this that make me wish for or_return in C and C++

@Arctis-Fireblight Arctis-Fireblight Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be really nice ;-;

if (token.type != TK_COLON) {
r_err_str = "Expected '::' after 'Variant'";
return ERR_PARSE_ERROR;
}

err = get_token(p_stream, token, line, r_err_str);
if (err) {
return err;
}
if (token.type != TK_COLON) {
r_err_str = "Expected '::' after 'Variant'";
return ERR_PARSE_ERROR;
}

err = get_token(p_stream, token, line, r_err_str);
if (err) {
return err;
}

if (token.type != TK_IDENTIFIER) {
r_err_str = "Expected identifier after 'Variant::'";
return ERR_PARSE_ERROR;
}

String constant = token.value;
if (constant == "NIL") {
value = Variant();
} else {
r_err_str = vformat("Unknown Variant constant '%s'", constant);
return ERR_PARSE_ERROR;
}
} else if (id == "Vector2") {
Vector<real_t> args;
Error err = _parse_construct<real_t>(p_stream, args, line, r_err_str);
Expand Down
79 changes: 79 additions & 0 deletions tests/core/variant/test_variant.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@

#include "core/variant/variant.h"
#include "core/variant/variant_parser.h"
#include "core/variant/variant_utility.h"

#include "tests/test_macros.h"

Expand Down Expand Up @@ -2290,4 +2291,82 @@ TEST_CASE("[Variant] Operator NOT") {
}
}

TEST_CASE("[Variant] VariantParser for Variant::NIL") {
String errs;
int line;
Variant result;
Error err;

// Test Variant::NIL
{
VariantParser::StreamString ss;
ss.s = "Variant::NIL";
line = 1;
err = VariantParser::parse(&ss, result, errs, line);
CHECK_MESSAGE(err == OK, "Variant::NIL should parse without error");
CHECK_MESSAGE(result.get_type() == Variant::NIL, "Variant::NIL should result in a nil Variant");
}

// Test null (regression)
{
VariantParser::StreamString ss;
ss.s = "null";
line = 1;
err = VariantParser::parse(&ss, result, errs, line);
CHECK_MESSAGE(err == OK, "null should parse without error");
CHECK_MESSAGE(result.get_type() == Variant::NIL, "null should result in a nil Variant");
}

// Test nil (regression)
{
VariantParser::StreamString ss;
ss.s = "nil";
line = 1;
err = VariantParser::parse(&ss, result, errs, line);
CHECK_MESSAGE(err == OK, "nil should parse without error");
CHECK_MESSAGE(result.get_type() == Variant::NIL, "nil should result in a nil Variant");
}

// Test Variant::INVALID (error case)
{
VariantParser::StreamString ss;
ss.s = "Variant::INVALID";
line = 1;
err = VariantParser::parse(&ss, result, errs, line);
CHECK_MESSAGE(err != OK, "Variant::INVALID should produce a parse error");
CHECK_MESSAGE(errs.contains("Unknown Variant constant 'INVALID'"), "Error message should mention unknown constant");
}

// Test Variant (alone)
{
VariantParser::StreamString ss;
ss.s = "Variant";
line = 1;
err = VariantParser::parse(&ss, result, errs, line);
CHECK_MESSAGE(err != OK, "Variant alone should produce a parse error");
CHECK_MESSAGE(errs.contains("Expected '::' after 'Variant'"), "Error message should mention expected '::'");
}

// Test p_allow_objects security gating
{
VariantParser::StreamString ss;
ss.s = "Object(RefCounted, {})";
line = 1;
err = VariantParser::parse(&ss, result, errs, line, nullptr, false); // p_allow_objects = false
CHECK_MESSAGE(err == ERR_UNAUTHORIZED, "Object parsing should be unauthorized when p_allow_objects is false");
}

{
VariantParser::StreamString ss;
ss.s = "Variant::NIL";
line = 1;
err = VariantParser::parse(&ss, result, errs, line, nullptr, false); // p_allow_objects = false
CHECK_MESSAGE(err == OK, "Variant::NIL should be allowed even when p_allow_objects is false");
}

// Test with str_to_var
Variant v = VariantUtilityFunctions::str_to_var("Variant::NIL");
CHECK_MESSAGE(v.get_type() == Variant::NIL, "str_to_var(\"Variant::NIL\") should result in a nil Variant");
}

} // namespace TestVariant
Loading