godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/gdscript/gdscript_codegen.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

170 lines
11 KiB
C++
Raw Normal View History

Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
/**************************************************************************/
/* gdscript_codegen.h */
/**************************************************************************/
/* 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. */
/**************************************************************************/
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-23 21:41:51 +00:00
#ifndef GDSCRIPT_CODEGEN_H
#define GDSCRIPT_CODEGEN_H
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
#include "gdscript_function.h"
GDScript: Refactor builtin functions They are now called "utility functions" to avoid confusion with methods of builtin types, and be consistent with the naming in Variant. Core utility functions are now available in GDScript. The ones missing in core are added specifically to GDScript as helpers for convenience. Some functions were remove when there are better ways to do, reducing redundancy and cleaning up the global scope.
2020-11-26 14:56:32 +00:00
#include "gdscript_utility_functions.h"
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
Style: Harmonize header includes in modules This applies our existing style guide, and adds a new rule to that style guide for modular components such as platform ports and modules: Includes from the platform port or module ("local" includes) should be listed first in their own block using relative paths, before Godot's "core" includes which use "absolute" (project folder relative) paths, and finally thirdparty includes. Includes in `#ifdef`s come after their relevant section, i.e. the overall structure is: - Local includes * Conditional local includes - Core includes * Conditional core includes - Thirdparty includes * Conditional thirdparty includes
2023-06-13 14:56:21 +00:00
#include "core/string/string_name.h"
#include "core/variant/variant.h"
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
class GDScriptCodeGenerator {
public:
struct Address {
enum AddressMode {
SELF,
CLASS,
MEMBER,
CONSTANT,
LOCAL_VARIABLE,
FUNCTION_PARAMETER,
TEMPORARY,
NIL,
};
AddressMode mode = NIL;
uint32_t address = 0;
GDScriptDataType type;
Address() {}
Address(AddressMode p_mode, const GDScriptDataType &p_type = GDScriptDataType()) {
mode = p_mode;
type = p_type;
}
Address(AddressMode p_mode, uint32_t p_address, const GDScriptDataType &p_type = GDScriptDataType()) {
Fix use of comma instead of semicolon Signed-off-by: Quentin Guidée <quentin.guidee@gmail.com>
2022-12-18 01:14:28 +00:00
mode = p_mode;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
address = p_address;
type = p_type;
}
};
virtual uint32_t add_parameter(const StringName &p_name, bool p_is_optional, const GDScriptDataType &p_type) = 0;
virtual uint32_t add_local(const StringName &p_name, const GDScriptDataType &p_type) = 0;
virtual uint32_t add_local_constant(const StringName &p_name, const Variant &p_constant) = 0;
virtual uint32_t add_or_get_constant(const Variant &p_constant) = 0;
virtual uint32_t add_or_get_name(const StringName &p_name) = 0;
GDScript: Pool temporary values by type on the stack So the stack slots perform less type changes, which is useful for future optimizations.
2021-04-14 17:35:51 +00:00
virtual uint32_t add_temporary(const GDScriptDataType &p_type) = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void pop_temporary() = 0;
GDScript: Fix uninitialized local variables not being reset
2024-03-28 18:57:56 +00:00
virtual void clear_temporaries() = 0;
virtual void clear_address(const Address &p_address) = 0;
virtual bool is_local_dirty(const Address &p_address) const = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void start_parameters() = 0;
virtual void end_parameters() = 0;
virtual void start_block() = 0;
virtual void end_block() = 0;
[Net] Modularize multiplayer, expose MultiplayerAPI to extensions. - RPC configurations are now dictionaries. - Script.get_rpc_methods renamed to Script.get_rpc_config. - Node.rpc[_id] and Callable.rpc now return an Error. - Refactor MultiplayerAPI to allow extension. - New MultiplayerAPI.rpc method with Array argument (for scripts). - Move the default MultiplayerAPI implementation to a module.
2022-07-12 21:12:42 +00:00
virtual void write_start(GDScript *p_script, const StringName &p_function_name, bool p_static, Variant p_rpc_config, const GDScriptDataType &p_return_type) = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual GDScriptFunction *write_end() = 0;
#ifdef DEBUG_ENABLED
virtual void set_signature(const String &p_signature) = 0;
#endif
virtual void set_initial_line(int p_line) = 0;
GDScript: Adjust type of temporaries when needed
2021-04-16 15:04:08 +00:00
virtual void write_type_adjust(const Address &p_target, Variant::Type p_new_type) = 0;
GDScript: Improve handling of operators - Use the new functions in Variant to determine the validity and resulting type of operators. - Split the operator function in codegen between binary and unary, since the unary ones have now a special requirement of having the second argument to be the NIL type when requesting info.
2020-11-26 17:41:55 +00:00
virtual void write_unary_operator(const Address &p_target, Variant::Operator p_operator, const Address &p_left_operand) = 0;
virtual void write_binary_operator(const Address &p_target, Variant::Operator p_operator, const Address &p_left_operand, const Address &p_right_operand) = 0;
GDScript: Rework type check
2023-02-16 23:16:24 +00:00
virtual void write_type_test(const Address &p_target, const Address &p_source, const GDScriptDataType &p_type) = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_and_left_operand(const Address &p_left_operand) = 0;
virtual void write_and_right_operand(const Address &p_right_operand) = 0;
virtual void write_end_and(const Address &p_target) = 0;
virtual void write_or_left_operand(const Address &p_left_operand) = 0;
virtual void write_or_right_operand(const Address &p_right_operand) = 0;
virtual void write_end_or(const Address &p_target) = 0;
virtual void write_start_ternary(const Address &p_target) = 0;
virtual void write_ternary_condition(const Address &p_condition) = 0;
virtual void write_ternary_true_expr(const Address &p_expr) = 0;
virtual void write_ternary_false_expr(const Address &p_expr) = 0;
virtual void write_end_ternary() = 0;
virtual void write_set(const Address &p_target, const Address &p_index, const Address &p_source) = 0;
virtual void write_get(const Address &p_target, const Address &p_index, const Address &p_source) = 0;
virtual void write_set_named(const Address &p_target, const StringName &p_name, const Address &p_source) = 0;
virtual void write_get_named(const Address &p_target, const StringName &p_name, const Address &p_source) = 0;
virtual void write_set_member(const Address &p_value, const StringName &p_name) = 0;
virtual void write_get_member(const Address &p_target, const StringName &p_name) = 0;
GDScript: Fix some bugs with static variables and functions
2023-05-16 10:03:53 +00:00
virtual void write_set_static_variable(const Address &p_value, const Address &p_class, int p_index) = 0;
virtual void write_get_static_variable(const Address &p_target, const Address &p_class, int p_index) = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_assign(const Address &p_target, const Address &p_source) = 0;
GDScript: Use analyzer data to decide assignment conversion Since there might be tricky cases in the analyzer (in the case of unsafe lines) which would need to be properly checked again. Instead, this splits the code generator in two functions and use information set by the analyzer to tell which function to use, without a need to re-check.
2021-05-26 17:05:31 +00:00
virtual void write_assign_with_conversion(const Address &p_target, const Address &p_source) = 0;
GDScript: Fix uninitialized local variables not being reset
2024-03-28 18:57:56 +00:00
virtual void write_assign_null(const Address &p_target) = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_assign_true(const Address &p_target) = 0;
virtual void write_assign_false(const Address &p_target) = 0;
GDScript: Fix missing conversion for default argument values
2023-01-06 09:49:06 +00:00
virtual void write_assign_default_parameter(const Address &dst, const Address &src, bool p_use_conversion) = 0;
GDScript: Fix loading of interdependent autoloads Move the autoload resolution to runtime by loading it into the stack with an extra instruction. This allows an autoload to use another autoload singleton independent of load order.
2021-09-01 19:01:39 +00:00
virtual void write_store_global(const Address &p_dst, int p_global_index) = 0;
Reduce number of addressing modes in GDScript VM There's now only 3 addressing modes: stack, constant, and member. Self, class, and nil are now present respectively in the first 3 stack slots. Global and class constants are moved to local constants when compiling. Named globals is only present on editor to use on tool singletons, so its use now emits a new instruction to copy the global to the stack. This allow us to further optimize the VM later by embedding the addressing modes in the instructions themselves, which is better done with less permutations.
2021-04-08 14:55:24 +00:00
virtual void write_store_named_global(const Address &p_dst, const StringName &p_global) = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_cast(const Address &p_target, const Address &p_source, const GDScriptDataType &p_type) = 0;
virtual void write_call(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) = 0;
virtual void write_super_call(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) = 0;
virtual void write_call_async(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) = 0;
GDScript: Refactor builtin functions They are now called "utility functions" to avoid confusion with methods of builtin types, and be consistent with the naming in Variant. Core utility functions are now available in GDScript. The ones missing in core are added specifically to GDScript as helpers for convenience. Some functions were remove when there are better ways to do, reducing redundancy and cleaning up the global scope.
2020-11-26 14:56:32 +00:00
virtual void write_call_utility(const Address &p_target, const StringName &p_function, const Vector<Address> &p_arguments) = 0;
GDScript: Add names for disassembling function pointers When instructions use function pointers, it's not possible to retrieve their original names in the disassembly. This stores the names in vectors (in debug builds) so they can be shown.
2022-12-29 13:47:53 +00:00
virtual void write_call_gdscript_utility(const Address &p_target, const StringName &p_function, const Vector<Address> &p_arguments) = 0;
GDScript: Add faster call instructions for builtin methods Methods from builtin types can be called by using the function pointer when the argument and base types are known at compile time.
2020-11-18 13:32:28 +00:00
virtual void write_call_builtin_type(const Address &p_target, const Address &p_base, Variant::Type p_type, const StringName &p_method, const Vector<Address> &p_arguments) = 0;
GDScript: Add support for builtin static method calls
2021-05-16 14:48:53 +00:00
virtual void write_call_builtin_type_static(const Address &p_target, Variant::Type p_type, const StringName &p_method, const Vector<Address> &p_arguments) = 0;
GDScript: Add support for static method calls in native types
2022-04-06 17:14:38 +00:00
virtual void write_call_native_static(const Address &p_target, const StringName &p_class, const StringName &p_method, const Vector<Address> &p_arguments) = 0;
GDScript: Perform validated calls with static methods When the types are validated at compile time, this type of call runs faster. It is already used for instance methods, this adds this optimization to native static methods as well.
2024-04-26 00:05:53 +00:00
virtual void write_call_native_static_validated(const Address &p_target, MethodBind *p_method, const Vector<Address> &p_arguments) = 0;
GDScript: Add faster call instructions for native methods
2020-11-17 13:44:52 +00:00
virtual void write_call_method_bind(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) = 0;
GDScript: Replace ptrcalls on MethodBind to validated calls This improves the performance of typed calls to engine methods when the argument types are exact. Using validated calls delegate more of the work the core instead of doing argument unpacking in the VM. It also does not need different instructions for each return type, simplifying the code.
2023-07-25 15:42:07 +00:00
virtual void write_call_method_bind_validated(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_call_self(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) = 0;
Fix error when calling coroutine with await in _ready The code paths for calling async functions seemed to be missing in some cases, causing a debug break and false positive error.
2020-12-04 23:42:45 +00:00
virtual void write_call_self_async(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_call_script_function(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) = 0;
GDScript: Allow using self in lambdas
2022-04-20 17:22:22 +00:00
virtual void write_lambda(const Address &p_target, GDScriptFunction *p_function, const Vector<Address> &p_captures, bool p_use_self) = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_construct(const Address &p_target, Variant::Type p_type, const Vector<Address> &p_arguments) = 0;
virtual void write_construct_array(const Address &p_target, const Vector<Address> &p_arguments) = 0;
Add typed arrays to GDScript - Use `Array[type]` for type-hints. e.g.: `var array: Array[int] = [1, 2, 3]` - Array literals are typed if their storage is typed (variable asssignment of as argument in function all). Otherwise they are untyped.
2021-03-09 15:32:35 +00:00
virtual void write_construct_typed_array(const Address &p_target, const GDScriptDataType &p_element_type, const Vector<Address> &p_arguments) = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_construct_dictionary(const Address &p_target, const Vector<Address> &p_arguments) = 0;
Implement typed dictionaries
2023-06-24 18:03:28 +00:00
virtual void write_construct_typed_dictionary(const Address &p_target, const GDScriptDataType &p_key_type, const GDScriptDataType &p_value_type, const Vector<Address> &p_arguments) = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_await(const Address &p_target, const Address &p_operand) = 0;
virtual void write_if(const Address &p_condition) = 0;
virtual void write_else() = 0;
virtual void write_endif() = 0;
GDScript: Fix setter being called in chains for shared types When a type is shared (i.e. passed by reference) it doesn't need to be called in a setter chain (e.g. `a.b.c = 0`) since it will be updated in place. This commit adds an instruction that jumps when the value is shared so it can be used to skip those cases and avoid redundant calls of setters. It also solves issues when assigning to sub-properties of read-only properties.
2022-06-27 15:09:51 +00:00
virtual void write_jump_if_shared(const Address &p_value) = 0;
virtual void write_end_jump_if_shared() = 0;
GDScript: Fix mishandling of stack pointers - Replace the for loop temporaries by locals. They cause conflicts with the stack when being popped, while locals are properly handled in the scope. - Change the interface for the codegen so the for loop list doesn't live through the whole block if it's a temporary. - Keep track of the actual amount of local variables in the stack. Using the size of the map is misleading in cases where multiple locals have the same name (which is allowed when there's no shadowing). - Added a few debug checks for temporaries, to avoid them being wrongly manipulated in the future. They should not live more than a line of code. - Rearrange some of compiler code to make sure the temporaries don't live across blocks.
2020-11-22 15:24:40 +00:00
virtual void start_for(const GDScriptDataType &p_iterator_type, const GDScriptDataType &p_list_type) = 0;
GDScript: Add static typing for `for` loop variable
2023-08-04 09:19:11 +00:00
virtual void write_for_assignment(const Address &p_list) = 0;
virtual void write_for(const Address &p_variable, bool p_use_conversion) = 0;
Add GDScript code generation interface Implement the abstraction by targeting the current VM.
2020-07-28 18:17:49 +00:00
virtual void write_endfor() = 0;
virtual void start_while_condition() = 0; // Used to allow a jump to the expression evaluation.
virtual void write_while(const Address &p_condition) = 0;
virtual void write_endwhile() = 0;
virtual void write_break() = 0;
virtual void write_continue() = 0;
virtual void write_breakpoint() = 0;
virtual void write_newline(int p_line) = 0;
virtual void write_return(const Address &p_return_value) = 0;
virtual void write_assert(const Address &p_test, const Address &p_message) = 0;
virtual ~GDScriptCodeGenerator() {}
};
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-23 21:41:51 +00:00
#endif // GDSCRIPT_CODEGEN_H