mirror of
https://github.com/godotengine/godot.git
synced 2024-12-09 10:09:20 +08:00
ad6e2e82a9
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.
91 lines
5.2 KiB
C++
91 lines
5.2 KiB
C++
/*************************************************************************/
|
|
/* gdscript_warning.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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. */
|
|
/*************************************************************************/
|
|
|
|
#ifndef GDSCRIPT_WARNINGS
|
|
#define GDSCRIPT_WARNINGS
|
|
|
|
#ifdef DEBUG_ENABLED
|
|
|
|
#include "core/string/ustring.h"
|
|
#include "core/templates/vector.h"
|
|
|
|
class GDScriptWarning {
|
|
public:
|
|
enum Code {
|
|
UNASSIGNED_VARIABLE, // Variable used but never assigned.
|
|
UNASSIGNED_VARIABLE_OP_ASSIGN, // Variable never assigned but used in an assignment operation (+=, *=, etc).
|
|
UNUSED_VARIABLE, // Local variable is declared but never used.
|
|
UNUSED_LOCAL_CONSTANT, // Local constant is declared but never used.
|
|
SHADOWED_VARIABLE, // Variable name shadowed by other variable in same class.
|
|
SHADOWED_VARIABLE_BASE_CLASS, // Variable name shadowed by other variable in some base class.
|
|
UNUSED_PRIVATE_CLASS_VARIABLE, // Class variable is declared private ("_" prefix) but never used in the file.
|
|
UNUSED_PARAMETER, // Function parameter is never used.
|
|
UNREACHABLE_CODE, // Code after a return statement.
|
|
UNREACHABLE_PATTERN, // Pattern in a match statement after a catch all pattern (wildcard or bind).
|
|
STANDALONE_EXPRESSION, // Expression not assigned to a variable.
|
|
VOID_ASSIGNMENT, // Function returns void but it's assigned to a variable.
|
|
NARROWING_CONVERSION, // Float value into an integer slot, precision is lost.
|
|
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.
|
|
PROPERTY_USED_AS_FUNCTION, // Function not found, but there's a property with the same name.
|
|
CONSTANT_USED_AS_FUNCTION, // Function not found, but there's a constant with the same name.
|
|
FUNCTION_USED_AS_PROPERTY, // Property not found, but there's a function with the same name.
|
|
INTEGER_DIVISION, // Integer divide by integer, decimal part is discarded.
|
|
UNSAFE_PROPERTY_ACCESS, // Property not found in the detected type (but can be in subtypes).
|
|
UNSAFE_METHOD_ACCESS, // Function not found in the detected type (but can be in subtypes).
|
|
UNSAFE_CAST, // Cast used in an unknown type.
|
|
UNSAFE_CALL_ARGUMENT, // Function call argument is of a supertype of the require argument.
|
|
DEPRECATED_KEYWORD, // The keyword is deprecated and should be replaced.
|
|
STANDALONE_TERNARY, // Return value of ternary expression is discarded.
|
|
ASSERT_ALWAYS_TRUE, // Expression for assert argument is always true.
|
|
ASSERT_ALWAYS_FALSE, // Expression for assert argument is always false.
|
|
REDUNDANT_AWAIT, // await is used but expression is synchronous (not a signal nor a coroutine).
|
|
EMPTY_FILE, // A script file is empty.
|
|
SHADOWED_GLOBAL_IDENTIFIER, // A global class or function has the same name as variable.
|
|
INT_ASSIGNED_TO_ENUM, // An integer value was assigned to an enum-typed variable without casting.
|
|
WARNING_MAX,
|
|
};
|
|
|
|
Code code = WARNING_MAX;
|
|
int start_line = -1, end_line = -1;
|
|
int leftmost_column = -1, rightmost_column = -1;
|
|
Vector<String> symbols;
|
|
|
|
String get_name() const;
|
|
String get_message() const;
|
|
static String get_name_from_code(Code p_code);
|
|
static Code get_code_from_name(const String &p_name);
|
|
};
|
|
|
|
#endif // DEBUG_ENABLED
|
|
|
|
#endif // GDSCRIPT_WARNINGS
|