Sara.Sync
/
godot-cpp
mirror of https://github.com/godotengine/godot-cpp
0
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Make generated code mostly style compliant

pull/1528/head
A Thousand Ships 2024-06-18 16:53:21 +02:00
parent 0a1e31fa45
commit f131efb791
No known key found for this signature in database
GPG Key ID: 2033189A662F8BD7
1 changed files with 113 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

159
binding_generator.py
View File

@ -542,8 +542,14 @@ def generate_builtin_bindings(api, output_dir, build_config):
builtin_header.append("") builtin_header.append("")
includes = []
for builtin in builtin_classes: for builtin in builtin_classes:
builtin_header.append(f"#include <godot_cpp/variant/{camel_to_snake(builtin)}.hpp>") includes.append(f"godot_cpp/variant/{camel_to_snake(builtin)}.hpp")
includes.sort()
for include in includes:
builtin_header.append(f"#include <{include}>")
builtin_header.append("") builtin_header.append("")
@ -599,11 +605,10 @@ def generate_builtin_class_vararg_method_implements_header(builtin_classes):
continue continue
result += make_varargs_template( result += make_varargs_template(
method, "is_static" in method and method["is_static"], class_name, False, False, True method, "is_static" in method and method["is_static"], class_name, False, True
) )
result.append("") result.append("")
result.append("")
result.append(f"#endif // ! {header_guard}") result.append(f"#endif // ! {header_guard}")
return "\n".join(result) return "\n".join(result)
@ -628,38 +633,53 @@ def generate_builtin_class_header(builtin_api, size, used_classes, fully_used_cl
# Special cases. # Special cases.
if class_name == "String": if class_name == "String":
result.append("#include <godot_cpp/classes/global_constants.hpp>")
result.append("#include <godot_cpp/variant/char_string.hpp>") result.append("#include <godot_cpp/variant/char_string.hpp>")
result.append("#include <godot_cpp/variant/char_utils.hpp>") result.append("#include <godot_cpp/variant/char_utils.hpp>")
result.append("#include <godot_cpp/classes/global_constants.hpp>") result.append("")
if class_name == "PackedStringArray": if class_name == "PackedStringArray":
result.append("#include <godot_cpp/variant/string.hpp>") result.append("#include <godot_cpp/variant/string.hpp>")
result.append("")
if class_name == "PackedColorArray": if class_name == "PackedColorArray":
result.append("#include <godot_cpp/variant/color.hpp>") result.append("#include <godot_cpp/variant/color.hpp>")
result.append("")
if class_name == "PackedVector2Array": if class_name == "PackedVector2Array":
result.append("#include <godot_cpp/variant/vector2.hpp>") result.append("#include <godot_cpp/variant/vector2.hpp>")
result.append("")
if class_name == "PackedVector3Array": if class_name == "PackedVector3Array":
result.append("#include <godot_cpp/variant/vector3.hpp>") result.append("#include <godot_cpp/variant/vector3.hpp>")
result.append("")
if class_name == "PackedVector4Array": if class_name == "PackedVector4Array":
result.append("#include <godot_cpp/variant/vector4.hpp>") result.append("#include <godot_cpp/variant/vector4.hpp>")
result.append("")
if is_packed_array(class_name): if is_packed_array(class_name):
result.append("#include <godot_cpp/core/error_macros.hpp>") result.append("#include <godot_cpp/core/error_macros.hpp>")
result.append("#include <initializer_list>") result.append("#include <initializer_list>")
result.append("")
if class_name == "Array": if class_name == "Array":
result.append("#include <godot_cpp/variant/array_helpers.hpp>") result.append("#include <godot_cpp/variant/array_helpers.hpp>")
result.append("")
if class_name == "Callable": if class_name == "Callable":
result.append("#include <godot_cpp/variant/callable_custom.hpp>") result.append("#include <godot_cpp/variant/callable_custom.hpp>")
result.append("")
for include in fully_used_classes:
if include == "TypedArray":
result.append("#include <godot_cpp/variant/typed_array.hpp>")
else:
result.append(f"#include <godot_cpp/{get_include_path(include)}>")
if len(fully_used_classes) > 0: if len(fully_used_classes) > 0:
includes = []
for include in fully_used_classes:
if include == "TypedArray":
includes.append("godot_cpp/variant/typed_array.hpp")
else:
includes.append(f"godot_cpp/{get_include_path(include)}")
includes.sort()
for include in includes:
result.append(f"#include <{include}>")
result.append("") result.append("")
result.append("#include <gdextension_interface.h>") result.append("#include <gdextension_interface.h>")
@ -737,7 +757,7 @@ def generate_builtin_class_header(builtin_api, size, used_classes, fully_used_cl
result.append("public:") result.append("public:")
result.append( result.append(
f"\t_FORCE_INLINE_ GDExtensionTypePtr _native_ptr() const {{ return const_cast<uint8_t (*)[{snake_class_name}_SIZE]>(&opaque); }}" f"\t_FORCE_INLINE_ GDExtensionTypePtr _native_ptr() const {{ return const_cast<uint8_t(*)[{snake_class_name}_SIZE]>(&opaque); }}"
) )
copy_constructor_index = -1 copy_constructor_index = -1
@ -980,8 +1000,7 @@ def generate_builtin_class_header(builtin_api, size, used_classes, fully_used_cl
} }
_FORCE_INLINE_ ConstIterator end() const { _FORCE_INLINE_ ConstIterator end() const {
return ConstIterator(ptr() + size()); return ConstIterator(ptr() + size());
} }"""
"""
result.append(iterators.replace("$TYPE", return_type)) result.append(iterators.replace("$TYPE", return_type))
init_list = """ init_list = """
_FORCE_INLINE_ $CLASS(std::initializer_list<$TYPE> p_init) { _FORCE_INLINE_ $CLASS(std::initializer_list<$TYPE> p_init) {
@ -991,8 +1010,7 @@ def generate_builtin_class_header(builtin_api, size, used_classes, fully_used_cl
for (const $TYPE &element : p_init) { for (const $TYPE &element : p_init) {
set(i++, element); set(i++, element);
} }
} }"""
"""
result.append(init_list.replace("$TYPE", return_type).replace("$CLASS", class_name)) result.append(init_list.replace("$TYPE", return_type).replace("$CLASS", class_name))
if class_name == "Array": if class_name == "Array":
@ -1031,7 +1049,9 @@ def generate_builtin_class_header(builtin_api, size, used_classes, fully_used_cl
result.append("") result.append("")
result.append("} // namespace godot") result.append("} // namespace godot")
result.append("")
result.append(f"#endif // ! {header_guard}") result.append(f"#endif // ! {header_guard}")
result.append("")
return "\n".join(result) return "\n".join(result)
@ -1045,7 +1065,6 @@ def generate_builtin_class_source(builtin_api, size, used_classes, fully_used_cl
add_header(f"{snake_class_name}.cpp", result) add_header(f"{snake_class_name}.cpp", result)
result.append("")
result.append(f"#include <godot_cpp/variant/{snake_class_name}.hpp>") result.append(f"#include <godot_cpp/variant/{snake_class_name}.hpp>")
result.append("") result.append("")
result.append("#include <godot_cpp/core/binder_common.hpp>") result.append("#include <godot_cpp/core/binder_common.hpp>")
@ -1054,10 +1073,16 @@ def generate_builtin_class_source(builtin_api, size, used_classes, fully_used_cl
result.append("") result.append("")
# Only used since the "fully used" is included in header already. # Only used since the "fully used" is included in header already.
for include in used_classes:
result.append(f"#include <godot_cpp/{get_include_path(include)}>")
if len(used_classes) > 0: if len(used_classes) > 0:
includes = []
for included in used_classes:
includes.append(f"godot_cpp/{get_include_path(included)}")
includes.sort()
for included in includes:
result.append(f"#include <{included}>")
result.append("") result.append("")
result.append("#include <godot_cpp/core/builtin_ptrcall.hpp>") result.append("#include <godot_cpp/core/builtin_ptrcall.hpp>")
@ -1307,7 +1332,7 @@ def generate_builtin_class_source(builtin_api, size, used_classes, fully_used_cl
f'{correct_type(operator["return_type"])} {class_name}::operator{operator["name"].replace("unary", "")}() const {{' f'{correct_type(operator["return_type"])} {class_name}::operator{operator["name"].replace("unary", "")}() const {{'
) )
result.append( result.append(
f'\treturn internal::_call_builtin_operator_ptr<{get_gdextension_type(correct_type(operator["return_type"]))}>(_method_bindings.operator_{get_operator_id_name(operator["name"])}, (GDExtensionConstTypePtr)&opaque, (GDExtensionConstTypePtr)nullptr);' f'\treturn internal::_call_builtin_operator_ptr<{get_gdextension_type(correct_type(operator["return_type"]))}>(_method_bindings.operator_{get_operator_id_name(operator["name"])}, (GDExtensionConstTypePtr)&opaque, (GDExtensionConstTypePtr) nullptr);'
) )
result.append("}") result.append("}")
result.append("") result.append("")
@ -1343,6 +1368,7 @@ def generate_builtin_class_source(builtin_api, size, used_classes, fully_used_cl
result.append("") result.append("")
result.append("} //namespace godot") result.append("} //namespace godot")
result.append("")
return "\n".join(result) return "\n".join(result)
@ -1518,11 +1544,18 @@ def generate_engine_classes_bindings(api, output_dir, use_template_get_node):
result.append("") result.append("")
if len(used_classes) > 0:
includes = []
for included in used_classes: for included in used_classes:
result.append(f"#include <godot_cpp/{get_include_path(included)}>") includes.append(f"godot_cpp/{get_include_path(included)}")
if len(used_classes) == 0: includes.sort()
for include in includes:
result.append(f"#include <{include}>")
else:
result.append("#include <godot_cpp/core/method_ptrcall.hpp>") result.append("#include <godot_cpp/core/method_ptrcall.hpp>")
result.append("") result.append("")
result.append("namespace godot {") result.append("namespace godot {")
@ -1562,16 +1595,23 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
result.append("") result.append("")
if len(fully_used_classes) > 0:
includes = []
for included in fully_used_classes: for included in fully_used_classes:
if included == "TypedArray": if included == "TypedArray":
result.append("#include <godot_cpp/variant/typed_array.hpp>") includes.append("godot_cpp/variant/typed_array.hpp")
else: else:
result.append(f"#include <godot_cpp/{get_include_path(included)}>") includes.append(f"godot_cpp/{get_include_path(included)}")
includes.sort()
for include in includes:
result.append(f"#include <{include}>")
result.append("")
if class_name == "EditorPlugin": if class_name == "EditorPlugin":
result.append("#include <godot_cpp/classes/editor_plugin_registration.hpp>") result.append("#include <godot_cpp/classes/editor_plugin_registration.hpp>")
if len(fully_used_classes) > 0:
result.append("") result.append("")
if class_name != "Object" and class_name != "ClassDBSingleton": if class_name != "Object" and class_name != "ClassDBSingleton":
@ -1610,7 +1650,6 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
result.append("") result.append("")
result.append("public:") result.append("public:")
result.append("")
if "enums" in class_api: if "enums" in class_api:
for enum_api in class_api["enums"]: for enum_api in class_api["enums"]:
@ -1643,6 +1682,10 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
vararg = "is_vararg" in method and method["is_vararg"] vararg = "is_vararg" in method and method["is_vararg"]
if vararg:
result.append("")
result.append("private:")
method_signature = "\t" method_signature = "\t"
method_signature += make_signature( method_signature += make_signature(
class_name, method, for_header=True, use_template_get_node=use_template_get_node class_name, method, for_header=True, use_template_get_node=use_template_get_node
@ -1650,6 +1693,8 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
result.append(method_signature + ";") result.append(method_signature + ";")
if vararg: if vararg:
result.append("")
result.append("public:")
# Add templated version. # Add templated version.
result += make_varargs_template(method) result += make_varargs_template(method)
@ -1664,6 +1709,8 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
) )
result.append(method_signature + ";") result.append(method_signature + ";")
result.append("")
result.append("protected:") result.append("protected:")
# T is the custom class we want to register (from which the call initiates, going up the inheritance chain), # T is the custom class we want to register (from which the call initiates, going up the inheritance chain),
# B is its base class (can be a custom class too, that's why we pass it). # B is its base class (can be a custom class too, that's why we pass it).
@ -1680,7 +1727,7 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
# If the method is different from the base class, it means T overrides it, so it needs to be bound. # If the method is different from the base class, it means T overrides it, so it needs to be bound.
# Note that with an `if constexpr`, the code inside the `if` will not even be compiled if the # Note that with an `if constexpr`, the code inside the `if` will not even be compiled if the
# condition returns false (in such cases it can't compile due to ambiguity). # condition returns false (in such cases it can't compile due to ambiguity).
f"\t\tif constexpr (!std::is_same_v<decltype(&B::{method_name}),decltype(&T::{method_name})>) {{" f"\t\tif constexpr (!std::is_same_v<decltype(&B::{method_name}), decltype(&T::{method_name})>) {{"
) )
result.append(f"\t\t\tBIND_VIRTUAL_METHOD(T, {method_name});") result.append(f"\t\t\tBIND_VIRTUAL_METHOD(T, {method_name});")
result.append("\t\t}") result.append("\t\t}")
@ -1708,7 +1755,7 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
if class_name == "WorkerThreadPool": if class_name == "WorkerThreadPool":
result.append("\tenum {") result.append("\tenum {")
result.append("\tINVALID_TASK_ID = -1") result.append("\t\tINVALID_TASK_ID = -1")
result.append("\t};") result.append("\t};")
result.append("\ttypedef int64_t TaskID;") result.append("\ttypedef int64_t TaskID;")
result.append("\ttypedef int64_t GroupID;") result.append("\ttypedef int64_t GroupID;")
@ -1720,8 +1767,6 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
) )
if class_name == "Object": if class_name == "Object":
result.append("")
result.append("\ttemplate <typename T>") result.append("\ttemplate <typename T>")
result.append("\tstatic T *cast_to(Object *p_object);") result.append("\tstatic T *cast_to(Object *p_object);")
@ -1736,7 +1781,6 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
"\tT *get_node(const NodePath &p_path) const { return Object::cast_to<T>(get_node_internal(p_path)); }" "\tT *get_node(const NodePath &p_path) const { return Object::cast_to<T>(get_node_internal(p_path)); }"
) )
result.append("")
result.append("};") result.append("};")
result.append("") result.append("")
@ -1820,7 +1864,7 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
result.append(method_body) result.append(method_body)
result.append("\t} \\") result.append("\t} \\")
result.append("\t;") result.append("\t")
result.append("") result.append("")
result.append("#define CLASSDB_SINGLETON_VARIANT_CAST \\") result.append("#define CLASSDB_SINGLETON_VARIANT_CAST \\")
@ -1832,10 +1876,11 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
else: else:
result.append(f'\tVARIANT_ENUM_CAST({class_api["alias_for"]}::{enum_api["name"]}); \\') result.append(f'\tVARIANT_ENUM_CAST({class_api["alias_for"]}::{enum_api["name"]}); \\')
result.append("\t;") result.append("\t")
result.append("") result.append("")
result.append(f"#endif // ! {header_guard}") result.append(f"#endif // ! {header_guard}")
result.append("")
return "\n".join(result) return "\n".join(result)
@ -1857,10 +1902,16 @@ def generate_engine_class_source(class_api, used_classes, fully_used_classes, us
result.append("#include <godot_cpp/core/error_macros.hpp>") result.append("#include <godot_cpp/core/error_macros.hpp>")
result.append("") result.append("")
for included in used_classes:
result.append(f"#include <godot_cpp/{get_include_path(included)}>")
if len(used_classes) > 0: if len(used_classes) > 0:
includes = []
for included in used_classes:
includes.append(f"godot_cpp/{get_include_path(included)}")
includes.sort()
for included in includes:
result.append(f"#include <{included}>")
result.append("") result.append("")
result.append("namespace godot {") result.append("namespace godot {")
@ -2010,8 +2061,8 @@ def generate_engine_class_source(class_api, used_classes, fully_used_classes, us
result.append(method_signature) result.append(method_signature)
result.append("") result.append("")
result.append("} // namespace godot")
result.append("") result.append("")
result.append("} // namespace godot ")
return "\n".join(result) return "\n".join(result)
@ -2039,8 +2090,9 @@ def generate_global_constants(api, output_dir):
header.append("namespace godot {") header.append("namespace godot {")
header.append("") header.append("")
if len(api["global_constants"]) > 0:
for constant in api["global_constants"]: for constant in api["global_constants"]:
header.append(f'\tconst int64_t {escape_identifier(constant["name"])} = {constant["value"]};') header.append(f'const int64_t {escape_identifier(constant["name"])} = {constant["value"]};')
header.append("") header.append("")
@ -2049,13 +2101,13 @@ def generate_global_constants(api, output_dir):
continue continue
if enum_def["is_bitfield"]: if enum_def["is_bitfield"]:
header.append(f'\tenum {enum_def["name"]} : uint64_t {{') header.append(f'enum {enum_def["name"]} : uint64_t {{')
else: else:
header.append(f'\tenum {enum_def["name"]} {{') header.append(f'enum {enum_def["name"]} {{')
for value in enum_def["values"]: for value in enum_def["values"]:
header.append(f'\t\t{value["name"]} = {value["value"]},') header.append(f'\t{value["name"]} = {value["value"]},')
header.append("\t};") header.append("};")
header.append("") header.append("")
header.append("} // namespace godot") header.append("} // namespace godot")
@ -2174,11 +2226,17 @@ def generate_utility_functions(api, output_dir):
vararg = "is_vararg" in function and function["is_vararg"] vararg = "is_vararg" in function and function["is_vararg"]
if vararg:
header.append("")
header.append("private:")
function_signature = "\t" function_signature = "\t"
function_signature += make_signature("UtilityFunctions", function, for_header=True, static=True) function_signature += make_signature("UtilityFunctions", function, for_header=True, static=True)
header.append(function_signature + ";") header.append(function_signature + ";")
if vararg: if vararg:
header.append("")
header.append("public:")
# Add templated version. # Add templated version.
header += make_varargs_template(function, static=True) header += make_varargs_template(function, static=True)
@ -2199,8 +2257,8 @@ def generate_utility_functions(api, output_dir):
source.append("#include <godot_cpp/variant/utility_functions.hpp>") source.append("#include <godot_cpp/variant/utility_functions.hpp>")
source.append("") source.append("")
source.append("#include <godot_cpp/core/error_macros.hpp>")
source.append("#include <godot_cpp/core/engine_ptrcall.hpp>") source.append("#include <godot_cpp/core/engine_ptrcall.hpp>")
source.append("#include <godot_cpp/core/error_macros.hpp>")
source.append("") source.append("")
source.append("namespace godot {") source.append("namespace godot {")
source.append("") source.append("")
@ -2302,7 +2360,7 @@ def make_function_parameters(parameters, include_default=False, for_builtin=Fals
signature.append(parameter) signature.append(parameter)
if is_vararg: if is_vararg:
signature.append("const Args&... p_args") signature.append("const Args &...p_args")
return ", ".join(signature) return ", ".join(signature)
@ -2360,9 +2418,6 @@ def make_signature(
if "is_virtual" in function_data and function_data["is_virtual"]: if "is_virtual" in function_data and function_data["is_virtual"]:
function_signature += "virtual " function_signature += "virtual "
if is_vararg:
function_signature += "private: "
if static: if static:
function_signature += "static " function_signature += "static "
@ -2415,7 +2470,6 @@ def make_varargs_template(
function_data, function_data,
static=False, static=False,
class_befor_signature="", class_befor_signature="",
with_public_declare=True,
with_indent=True, with_indent=True,
for_builtin_classes=False, for_builtin_classes=False,
): ):
@ -2423,10 +2477,7 @@ def make_varargs_template(
function_signature = "" function_signature = ""
if with_public_declare: result.append("template <typename... Args>")
function_signature = "public: "
function_signature += "template <typename... Args> "
if static: if static:
function_signature += "static " function_signature += "static "
@ -2469,7 +2520,7 @@ def make_varargs_template(
function_signature += " {" function_signature += " {"
result.append(function_signature) result.append(function_signature)
args_array = f"\tstd::array<Variant, {len(method_arguments)} + sizeof...(Args)> variant_args {{ " args_array = f"\tstd::array<Variant, {len(method_arguments)} + sizeof...(Args)> variant_args{{ "
for argument in method_arguments: for argument in method_arguments:
if argument["type"] == "Variant": if argument["type"] == "Variant":
args_array += escape_argument(argument["name"]) args_array += escape_argument(argument["name"])