godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
721d280b8a
godot/modules/gdscript/gdscript_warning.cpp

272 lines
13 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 12:25:55 +00:00
/**************************************************************************/
/* gdscript_warning.cpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
#include "gdscript_warning.h"
Reorganized core/ directory, it was too fatty already -Removed FuncRef, since Callable makes it obsolete -Removed int_types.h as its obsolete in c++11+ -Changed color names code
2020-11-07 22:33:38 +00:00
#include "core/variant/variant.h"
Add warning checks in GDScript analyzer Reenable checking those when validating code.
2020-06-11 22:31:28 +00:00
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
#ifdef DEBUG_ENABLED
String GDScriptWarning::get_message() const {
#define CHECK_SYMBOLS(m_amount) ERR_FAIL_COND_V(symbols.size() < m_amount, String());
switch (code) {
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case UNASSIGNED_VARIABLE:
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
CHECK_SYMBOLS(1);
GDScript: Don't warn on unassigned for builtin-typed variables If the type of a variable is a built-in Variant type, then it will automatically be assigned a default value based on the type. This means that the explicit initialization may be unnecessary. Thus this commit removes the warning in such case. This also changes the meaning of the unassigned warning to happen when the variable is used before being assigned, not when it has zero assignments.
2024-04-09 17:15:51 +00:00
return vformat(R"(The variable "%s" was used before being assigned a value.)", symbols[0]);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case UNASSIGNED_VARIABLE_OP_ASSIGN:
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
CHECK_SYMBOLS(1);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
return vformat(R"(Using assignment with operation but the variable "%s" was not previously assigned a value.)", symbols[0]);
case UNUSED_VARIABLE:
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
CHECK_SYMBOLS(1);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
return vformat(R"(The local variable "%s" is declared but never used in the block. If this is intended, prefix it with an underscore: "_%s".)", symbols[0], symbols[0]);
case UNUSED_LOCAL_CONSTANT:
Add warning checks in GDScript analyzer Reenable checking those when validating code.
2020-06-11 22:31:28 +00:00
CHECK_SYMBOLS(1);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
return vformat(R"(The local constant "%s" is declared but never used in the block. If this is intended, prefix it with an underscore: "_%s".)", symbols[0], symbols[0]);
case UNUSED_PRIVATE_CLASS_VARIABLE:
CHECK_SYMBOLS(1);
GDScript: Fix `@warning_ignore` annotation issues
2024-02-28 14:23:11 +00:00
return vformat(R"(The class variable "%s" is declared but never used in the class.)", symbols[0]);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case UNUSED_PARAMETER:
CHECK_SYMBOLS(2);
return vformat(R"*(The parameter "%s" is never used in the function "%s()". If this is intended, prefix it with an underscore: "_%s".)*", symbols[1], symbols[0], symbols[1]);
case UNUSED_SIGNAL:
CHECK_SYMBOLS(1);
GDScript: Fix `@warning_ignore` annotation issues
2024-02-28 14:23:11 +00:00
return vformat(R"(The signal "%s" is declared but never explicitly used in the class.)", symbols[0]);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case SHADOWED_VARIABLE:
Add warning checks in GDScript analyzer Reenable checking those when validating code.
2020-06-11 22:31:28 +00:00
CHECK_SYMBOLS(4);
return vformat(R"(The local %s "%s" is shadowing an already-declared %s at line %s.)", symbols[0], symbols[1], symbols[2], symbols[3]);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case SHADOWED_VARIABLE_BASE_CLASS:
Add warning checks in GDScript analyzer Reenable checking those when validating code.
2020-06-11 22:31:28 +00:00
CHECK_SYMBOLS(4);
return vformat(R"(The local %s "%s" is shadowing an already-declared %s at the base class "%s".)", symbols[0], symbols[1], symbols[2], symbols[3]);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case SHADOWED_GLOBAL_IDENTIFIER:
CHECK_SYMBOLS(3);
return vformat(R"(The %s "%s" has the same name as a %s.)", symbols[0], symbols[1], symbols[2]);
case UNREACHABLE_CODE:
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
CHECK_SYMBOLS(1);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
return vformat(R"*(Unreachable code (statement after return) in function "%s()".)*", symbols[0]);
case UNREACHABLE_PATTERN:
Add warning checks in GDScript analyzer Reenable checking those when validating code.
2020-06-11 22:31:28 +00:00
return "Unreachable pattern (pattern after wildcard or bind).";
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case STANDALONE_EXPRESSION:
GDScript: Fix `STANDALONE_EXPRESSION` warning for `preload()`
2024-05-16 19:11:56 +00:00
return "Standalone expression (the line may have no effect).";
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case STANDALONE_TERNARY:
GDScript: Fix `@warning_ignore` annotation issues
2024-02-28 14:23:11 +00:00
return "Standalone ternary operator: the return value is being discarded.";
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case INCOMPATIBLE_TERNARY:
GDScript: Fix `@warning_ignore` annotation issues
2024-02-28 14:23:11 +00:00
return "Values of the ternary operator are not mutually compatible.";
Add "untyped_declaration" warning
2023-09-05 17:56:37 +00:00
case UNTYPED_DECLARATION:
CHECK_SYMBOLS(2);
if (symbols[0] == "Function") {
return vformat(R"*(%s "%s()" has no static return type.)*", symbols[0], symbols[1]);
}
return vformat(R"(%s "%s" has no static type.)", symbols[0], symbols[1]);
GDScript: Add `INFERRED_DECLARATION` warning
2023-09-22 17:57:24 +00:00
case INFERRED_DECLARATION:
CHECK_SYMBOLS(2);
return vformat(R"(%s "%s" has an implicitly inferred static type.)", symbols[0], symbols[1]);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case UNSAFE_PROPERTY_ACCESS:
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
CHECK_SYMBOLS(2);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
return vformat(R"(The property "%s" is not present on the inferred type "%s" (but may be present on a subtype).)", symbols[0], symbols[1]);
case UNSAFE_METHOD_ACCESS:
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
CHECK_SYMBOLS(2);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
return vformat(R"*(The method "%s()" is not present on the inferred type "%s" (but may be present on a subtype).)*", symbols[0], symbols[1]);
case UNSAFE_CAST:
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
CHECK_SYMBOLS(1);
GDScript: Fix `UNSAFE_CAST` warning
2023-10-27 08:08:54 +00:00
return vformat(R"(Casting "Variant" to "%s" is unsafe.)", symbols[0]);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case UNSAFE_CALL_ARGUMENT:
GDScript: Fix `UNSAFE_CALL_ARGUMENT` warning for `Variant` constructors
2023-09-29 19:43:56 +00:00
CHECK_SYMBOLS(5);
return vformat(R"*(The argument %s of the %s "%s()" requires the subtype "%s" but the supertype "%s" was provided.)*", symbols[0], symbols[1], symbols[2], symbols[3], symbols[4]);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case UNSAFE_VOID_RETURN:
GDScript: Allow void functions to return calls to other void functions
2023-01-27 20:54:07 +00:00
CHECK_SYMBOLS(2);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
return vformat(R"*(The method "%s()" returns "void" but it's trying to return a call to "%s()" that can't be ensured to also be "void".)*", symbols[0], symbols[1]);
case RETURN_VALUE_DISCARDED:
CHECK_SYMBOLS(1);
return vformat(R"*(The function "%s()" returns a value that will be discarded if not used.)*", symbols[0]);
case STATIC_CALLED_ON_INSTANCE:
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
CHECK_SYMBOLS(2);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
return vformat(R"*(The function "%s()" is a static function but was called from an instance. Instead, it should be directly called from the type: "%s.%s()".)*", symbols[0], symbols[1], symbols[0]);
GDScript: Add warning if non-`@tool` class extends `@tool` class
2024-07-04 07:23:44 +00:00
case MISSING_TOOL:
return R"(The base class script has the "@tool" annotation, but this script does not have it.)";
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case REDUNDANT_STATIC_UNLOAD:
return R"(The "@static_unload" annotation is redundant because the file does not have a class with static variables.)";
case REDUNDANT_AWAIT:
return R"("await" keyword not needed in this case, because the expression isn't a coroutine nor a signal.)";
case ASSERT_ALWAYS_TRUE:
Add warning checks in GDScript analyzer Reenable checking those when validating code.
2020-06-11 22:31:28 +00:00
return "Assert statement is redundant because the expression is always true.";
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case ASSERT_ALWAYS_FALSE:
Add warning checks in GDScript analyzer Reenable checking those when validating code.
2020-06-11 22:31:28 +00:00
return "Assert statement will raise an error because the expression is always false.";
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case INTEGER_DIVISION:
return "Integer division, decimal part will be discarded.";
case NARROWING_CONVERSION:
return "Narrowing conversion (float is converted to int and loses precision).";
case INT_AS_ENUM_WITHOUT_CAST:
GDScript: Consolidate behavior for assigning enum types This makes sure that assigning values to enum-typed variables are consistent. Same enum is always valid, different enum is always invalid (without casting) and assigning `int` creates a warning if there is no casting. There are new test cases to ensure this behavior doesn't break in the future.
2022-01-27 14:34:33 +00:00
return "Integer used when an enum value is expected. If this is intended cast the integer to the enum type.";
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case INT_AS_ENUM_WITHOUT_MATCH:
GDScript: Fix constant conversions
2023-01-22 08:32:05 +00:00
CHECK_SYMBOLS(3);
return vformat(R"(Cannot %s %s as Enum "%s": no enum member has matching value.)", symbols[0], symbols[1], symbols[2]);
GDScript: Warn when enum variable has no default The default will always be set to `0`, so if it's not a valid value in the enum, the warning is shown.
2024-04-16 14:16:36 +00:00
case ENUM_VARIABLE_WITHOUT_DEFAULT:
CHECK_SYMBOLS(1);
return vformat(R"(The variable "%s" has an enum type and does not set an explicit default value. The default will be set to "0".)", symbols[0]);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case EMPTY_FILE:
return "Empty script file.";
case DEPRECATED_KEYWORD:
Add STATIC_CALLED_ON_INSTANCE warning to highlight when static functions are called directly from objects
2022-10-13 19:42:11 +00:00
CHECK_SYMBOLS(2);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
return vformat(R"(The "%s" keyword is deprecated and will be removed in a future release, please replace its uses by "%s".)", symbols[0], symbols[1]);
case RENAMED_IN_GODOT_4_HINT:
break; // Renamed identifier hint is taken care of by the GDScriptAnalyzer. No message needed here.
case CONFUSABLE_IDENTIFIER:
Add support for Unicode identifiers in GDScript This is using an adapted version of UAX#31 to not rely on the ICU database (which isn't available in builds without TextServerAdvanced). It allows most characters used in diverse scripts but not everything.
2023-01-19 01:56:00 +00:00
CHECK_SYMBOLS(1);
return vformat(R"(The identifier "%s" has misleading characters and might be confused with something else.)", symbols[0]);
GDScript: Fix bug with identifier shadowed below in current scope
2023-07-25 11:21:49 +00:00
case CONFUSABLE_LOCAL_DECLARATION:
CHECK_SYMBOLS(2);
return vformat(R"(The %s "%s" is declared below in the parent block.)", symbols[0], symbols[1]);
case CONFUSABLE_LOCAL_USAGE:
CHECK_SYMBOLS(1);
return vformat(R"(The identifier "%s" will be shadowed below in the block.)", symbols[0]);
GDScript: Add `CONFUSABLE_CAPTURE_REASSIGNMENT` warning
2024-06-28 06:35:04 +00:00
case CONFUSABLE_CAPTURE_REASSIGNMENT:
CHECK_SYMBOLS(1);
return vformat(R"(Reassigning lambda capture does not modify the outer local variable "%s".)", symbols[0]);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case INFERENCE_ON_VARIANT:
GDScript: Add warnings that are set to error by default - Adds a list of default levels for all warning so they can be set individually. - Add warnings set by default to error for: - Using `get_node()` without `@onready`. - Using `@onready` together with `@export`. - Inferring a static type with a Variant value. - Overriding a native engine method. - Adjust how annotations to ignore warnings are treated so they also apply to method parameters. - Clean up a bit how ignored warnings are set. There were two sets but only one was actually being used. - Set all warnings to the `WARN` level for tests, so they they can be properly tested. - Fix enum types in native methods signatures being set to `int`. - Fix native enums being treated as Dictionary by mistake. - Make name of native enum types use the class they are defined in, not the direct super class of the script. This ensures they are always equal even when coming from different sources. - Fix error for signature mismatch that was only showing the first default argument as having a default. Now it shows for all.
2023-02-02 14:57:22 +00:00
CHECK_SYMBOLS(1);
return vformat("The %s type is being inferred from a Variant value, so it will be typed as Variant.", symbols[0]);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case NATIVE_METHOD_OVERRIDE:
GDScript: Add warnings that are set to error by default - Adds a list of default levels for all warning so they can be set individually. - Add warnings set by default to error for: - Using `get_node()` without `@onready`. - Using `@onready` together with `@export`. - Inferring a static type with a Variant value. - Overriding a native engine method. - Adjust how annotations to ignore warnings are treated so they also apply to method parameters. - Clean up a bit how ignored warnings are set. There were two sets but only one was actually being used. - Set all warnings to the `WARN` level for tests, so they they can be properly tested. - Fix enum types in native methods signatures being set to `int`. - Fix native enums being treated as Dictionary by mistake. - Make name of native enum types use the class they are defined in, not the direct super class of the script. This ensures they are always equal even when coming from different sources. - Fix error for signature mismatch that was only showing the first default argument as having a default. Now it shows for all.
2023-02-02 14:57:22 +00:00
CHECK_SYMBOLS(2);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
return vformat(R"*(The method "%s()" overrides a method from native class "%s". This won't be called by the engine and may not work as expected.)*", symbols[0], symbols[1]);
case GET_NODE_DEFAULT_WITHOUT_ONREADY:
GDScript: Add warnings that are set to error by default - Adds a list of default levels for all warning so they can be set individually. - Add warnings set by default to error for: - Using `get_node()` without `@onready`. - Using `@onready` together with `@export`. - Inferring a static type with a Variant value. - Overriding a native engine method. - Adjust how annotations to ignore warnings are treated so they also apply to method parameters. - Clean up a bit how ignored warnings are set. There were two sets but only one was actually being used. - Set all warnings to the `WARN` level for tests, so they they can be properly tested. - Fix enum types in native methods signatures being set to `int`. - Fix native enums being treated as Dictionary by mistake. - Make name of native enum types use the class they are defined in, not the direct super class of the script. This ensures they are always equal even when coming from different sources. - Fix error for signature mismatch that was only showing the first default argument as having a default. Now it shows for all.
2023-02-02 14:57:22 +00:00
CHECK_SYMBOLS(1);
return vformat(R"*(The default value is using "%s" which won't return nodes in the scene tree before "_ready()" is called. Use the "@onready" annotation to solve this.)*", symbols[0]);
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
case ONREADY_WITH_EXPORT:
Fix mistakes in documentation and GDScript errors
2023-04-06 06:04:22 +00:00
return R"("@onready" will set the default value after "@export" takes effect and will override it.)";
GDScript: Fix `@warning_ignore` annotation issues
2024-02-28 14:23:11 +00:00
#ifndef DISABLE_DEPRECATED
// Never produced. These warnings migrated from 3.x by mistake.
case PROPERTY_USED_AS_FUNCTION: // There is already an error.
case CONSTANT_USED_AS_FUNCTION: // There is already an error.
case FUNCTION_USED_AS_PROPERTY: // This is valid, returns `Callable`.
break;
#endif
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
case WARNING_MAX:
GDScript: Fix `@warning_ignore` annotation issues
2024-02-28 14:23:11 +00:00
break; // Can't happen, but silences warning.
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
}
GDScript: Fix `@warning_ignore` annotation issues
2024-02-28 14:23:11 +00:00
ERR_FAIL_V_MSG(String(), vformat(R"(Invalid GDScript warning "%s".)", get_name_from_code(code)));
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
#undef CHECK_SYMBOLS
}
Add enum values (Ignore, Warn, Error) to GDScript warnings
2022-03-23 02:44:30 +00:00
int GDScriptWarning::get_default_value(Code p_code) {
GDScript: Add warnings that are set to error by default - Adds a list of default levels for all warning so they can be set individually. - Add warnings set by default to error for: - Using `get_node()` without `@onready`. - Using `@onready` together with `@export`. - Inferring a static type with a Variant value. - Overriding a native engine method. - Adjust how annotations to ignore warnings are treated so they also apply to method parameters. - Clean up a bit how ignored warnings are set. There were two sets but only one was actually being used. - Set all warnings to the `WARN` level for tests, so they they can be properly tested. - Fix enum types in native methods signatures being set to `int`. - Fix native enums being treated as Dictionary by mistake. - Make name of native enum types use the class they are defined in, not the direct super class of the script. This ensures they are always equal even when coming from different sources. - Fix error for signature mismatch that was only showing the first default argument as having a default. Now it shows for all.
2023-02-02 14:57:22 +00:00
ERR_FAIL_INDEX_V_MSG(p_code, WARNING_MAX, WarnLevel::IGNORE, "Getting default value of invalid warning code.");
return default_warning_levels[p_code];
Add enum values (Ignore, Warn, Error) to GDScript warnings
2022-03-23 02:44:30 +00:00
}
PropertyInfo GDScriptWarning::get_property_info(Code p_code) {
// Making this a separate function in case a warning needs different PropertyInfo in the future.
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
if (p_code == Code::RENAMED_IN_GODOT_4_HINT) {
Add hint for identifiers renamed since Godot 3
2022-03-23 17:54:41 +00:00
return PropertyInfo(Variant::BOOL, get_settings_path_from_code(p_code));
}
Add enum values (Ignore, Warn, Error) to GDScript warnings
2022-03-23 02:44:30 +00:00
return PropertyInfo(Variant::INT, get_settings_path_from_code(p_code), PROPERTY_HINT_ENUM, "Ignore,Warn,Error");
}
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
String GDScriptWarning::get_name() const {
return get_name_from_code(code);
}
String GDScriptWarning::get_name_from_code(Code p_code) {
ERR_FAIL_COND_V(p_code < 0 || p_code >= WARNING_MAX, String());
static const char *names[] = {
"UNASSIGNED_VARIABLE",
"UNASSIGNED_VARIABLE_OP_ASSIGN",
"UNUSED_VARIABLE",
Add warning checks in GDScript analyzer Reenable checking those when validating code.
2020-06-11 22:31:28 +00:00
"UNUSED_LOCAL_CONSTANT",
"UNUSED_PRIVATE_CLASS_VARIABLE",
"UNUSED_PARAMETER",
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
"UNUSED_SIGNAL",
"SHADOWED_VARIABLE",
"SHADOWED_VARIABLE_BASE_CLASS",
"SHADOWED_GLOBAL_IDENTIFIER",
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
"UNREACHABLE_CODE",
Add warning checks in GDScript analyzer Reenable checking those when validating code.
2020-06-11 22:31:28 +00:00
"UNREACHABLE_PATTERN",
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
"STANDALONE_EXPRESSION",
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
"STANDALONE_TERNARY",
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
"INCOMPATIBLE_TERNARY",
Add "untyped_declaration" warning
2023-09-05 17:56:37 +00:00
"UNTYPED_DECLARATION",
GDScript: Add `INFERRED_DECLARATION` warning
2023-09-22 17:57:24 +00:00
"INFERRED_DECLARATION",
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
"UNSAFE_PROPERTY_ACCESS",
"UNSAFE_METHOD_ACCESS",
"UNSAFE_CAST",
"UNSAFE_CALL_ARGUMENT",
GDScript: Allow void functions to return calls to other void functions
2023-01-27 20:54:07 +00:00
"UNSAFE_VOID_RETURN",
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
"RETURN_VALUE_DISCARDED",
"STATIC_CALLED_ON_INSTANCE",
GDScript: Add warning if non-`@tool` class extends `@tool` class
2024-07-04 07:23:44 +00:00
"MISSING_TOOL",
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
"REDUNDANT_STATIC_UNLOAD",
"REDUNDANT_AWAIT",
Add warning checks in GDScript analyzer Reenable checking those when validating code.
2020-06-11 22:31:28 +00:00
"ASSERT_ALWAYS_TRUE",
"ASSERT_ALWAYS_FALSE",
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
"INTEGER_DIVISION",
"NARROWING_CONVERSION",
GDScript: Fix constant conversions
2023-01-22 08:32:05 +00:00
"INT_AS_ENUM_WITHOUT_CAST",
"INT_AS_ENUM_WITHOUT_MATCH",
GDScript: Warn when enum variable has no default The default will always be set to `0`, so if it's not a valid value in the enum, the warning is shown.
2024-04-16 14:16:36 +00:00
"ENUM_VARIABLE_WITHOUT_DEFAULT",
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
"EMPTY_FILE",
"DEPRECATED_KEYWORD",
GDScript: Add warnings that are set to error by default - Adds a list of default levels for all warning so they can be set individually. - Add warnings set by default to error for: - Using `get_node()` without `@onready`. - Using `@onready` together with `@export`. - Inferring a static type with a Variant value. - Overriding a native engine method. - Adjust how annotations to ignore warnings are treated so they also apply to method parameters. - Clean up a bit how ignored warnings are set. There were two sets but only one was actually being used. - Set all warnings to the `WARN` level for tests, so they they can be properly tested. - Fix enum types in native methods signatures being set to `int`. - Fix native enums being treated as Dictionary by mistake. - Make name of native enum types use the class they are defined in, not the direct super class of the script. This ensures they are always equal even when coming from different sources. - Fix error for signature mismatch that was only showing the first default argument as having a default. Now it shows for all.
2023-02-02 14:57:22 +00:00
"RENAMED_IN_GODOT_4_HINT",
GDScript: Reorganize and unify warnings
2023-04-28 15:20:41 +00:00
"CONFUSABLE_IDENTIFIER",
GDScript: Fix bug with identifier shadowed below in current scope
2023-07-25 11:21:49 +00:00
"CONFUSABLE_LOCAL_DECLARATION",
"CONFUSABLE_LOCAL_USAGE",
GDScript: Add `CONFUSABLE_CAPTURE_REASSIGNMENT` warning
2024-06-28 06:35:04 +00:00
"CONFUSABLE_CAPTURE_REASSIGNMENT",
GDScript: Add warnings that are set to error by default - Adds a list of default levels for all warning so they can be set individually. - Add warnings set by default to error for: - Using `get_node()` without `@onready`. - Using `@onready` together with `@export`. - Inferring a static type with a Variant value. - Overriding a native engine method. - Adjust how annotations to ignore warnings are treated so they also apply to method parameters. - Clean up a bit how ignored warnings are set. There were two sets but only one was actually being used. - Set all warnings to the `WARN` level for tests, so they they can be properly tested. - Fix enum types in native methods signatures being set to `int`. - Fix native enums being treated as Dictionary by mistake. - Make name of native enum types use the class they are defined in, not the direct super class of the script. This ensures they are always equal even when coming from different sources. - Fix error for signature mismatch that was only showing the first default argument as having a default. Now it shows for all.
2023-02-02 14:57:22 +00:00
"INFERENCE_ON_VARIANT",
"NATIVE_METHOD_OVERRIDE",
"GET_NODE_DEFAULT_WITHOUT_ONREADY",
"ONREADY_WITH_EXPORT",
GDScript: Fix `@warning_ignore` annotation issues
2024-02-28 14:23:11 +00:00
#ifndef DISABLE_DEPRECATED
"PROPERTY_USED_AS_FUNCTION",
"CONSTANT_USED_AS_FUNCTION",
"FUNCTION_USED_AS_PROPERTY",
#endif
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
};
Add warning checks in GDScript analyzer Reenable checking those when validating code.
2020-06-11 22:31:28 +00:00
static_assert((sizeof(names) / sizeof(*names)) == WARNING_MAX, "Amount of warning types don't match the amount of warning names.");
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
return names[(int)p_code];
}
Add enum values (Ignore, Warn, Error) to GDScript warnings
2022-03-23 02:44:30 +00:00
String GDScriptWarning::get_settings_path_from_code(Code p_code) {
return "debug/gdscript/warnings/" + get_name_from_code(p_code).to_lower();
}
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
GDScriptWarning::Code GDScriptWarning::get_code_from_name(const String &p_name) {
for (int i = 0; i < WARNING_MAX; i++) {
if (get_name_from_code((Code)i) == p_name) {
return (Code)i;
}
}
GDScript: Add annotation to ignore warnings
2022-01-04 12:32:43 +00:00
return WARNING_MAX;
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
}
#endif // DEBUG_ENABLED
Reference in New Issue Copy Permalink