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

Jump to bottom

[3.x] Add GDScript warning when internal native C++ callback is overridden via script #42968

Closed
wants to merge 1 commit into from
Closed

[3.x] Add GDScript warning when internal native C++ callback is overridden via script #42968

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
5 changes: 5 additions & 0 deletions modules/gdscript/gdscript.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2079,6 +2079,10 @@ String GDScriptWarning::get_message() const {
CHECK_SYMBOLS(1);
return "Function declaration of '" + symbols[0] + "()' conflicts with a constant of the same name.";
} break;
case FUNCTION_OVERRIDES_INTERNAL_CALLBACK: {
CHECK_SYMBOLS(1);
return "Function declaration '" + symbols[0] + "()' overrides internal callback.";
} break;
case INCOMPATIBLE_TERNARY: {
return "Values of the ternary conditional are not mutually compatible.";
} break;
Expand Down Expand Up @@ -2158,6 +2162,7 @@ String GDScriptWarning::get_name_from_code(Code p_code) {
"VARIABLE_CONFLICTS_FUNCTION",
"FUNCTION_CONFLICTS_VARIABLE",
"FUNCTION_CONFLICTS_CONSTANT",
"FUNCTION_OVERRIDES_INTERNAL_CALLBACK",
"INCOMPATIBLE_TERNARY",
"UNUSED_SIGNAL",
"RETURN_VALUE_DISCARDED",
Expand Down
1 change: 1 addition & 0 deletions modules/gdscript/gdscript.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@ struct GDScriptWarning {
VARIABLE_CONFLICTS_FUNCTION, // Variable has the same name of a function
FUNCTION_CONFLICTS_VARIABLE, // Function has the same name of a variable
FUNCTION_CONFLICTS_CONSTANT, // Function has the same name of a constant
FUNCTION_OVERRIDES_INTERNAL_CALLBACK, // Function has the same name of an internal callback prefixed with "_".
INCOMPATIBLE_TERNARY, // Possible values of a ternary if are not mutually compatible
UNUSED_SIGNAL, // Signal is defined but never emitted
RETURN_VALUE_DISCARDED, // Function call returns something but the value isn't used
Expand Down
17 changes: 17 additions & 0 deletions modules/gdscript/gdscript_parser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5628,6 +5628,23 @@ void GDScriptParser::_determine_inheritance(ClassNode *p_class, bool p_recursive
_determine_inheritance(p_class->subclasses[i], p_recursive);
}
}
#ifdef DEBUG_METHODS_ENABLED
// Check whether script functions override any private callbacks in ClassDB.
List<MethodInfo> virtuals;
ClassDB::get_virtual_methods(p_class->base_type.native_type, &virtuals);
for (int i = 0; i < p_class->functions.size(); i++) {
for (const List<MethodInfo>::Element *E = virtuals.front(); E; E = E->next()) {
String func_name = p_class->functions[i]->name;
if (func_name == E->get().name) {
continue; // Overridding virtual methods is the way to go, skip.
}
if (func_name.begins_with("_") && ClassDB::has_method(p_class->base_type.native_type, func_name)) {
_add_warning(GDScriptWarning::FUNCTION_OVERRIDES_INTERNAL_CALLBACK, -1, func_name);
break;
}
}
}
#endif // DEBUG_METHODS_ENABLED
}

String GDScriptParser::DataType::to_string() const {
Expand Down