Improve gdapi.pxd & rename templates in src/godot/_builtins_pyx for better syntax highlighting

Author: touilleMan

scripts/extension_api_parser/api.py

@@ -1,4 +1,4 @@
-from typing import List, Dict
+from typing import List, Dict, Tuple
 from dataclasses import dataclass
 from pathlib import Path
 import json
@@ -57,7 +57,7 @@ class UtilityFunctionSpec:
     category: str
     is_vararg: bool
     hash: int
-    arguments: Dict[str, TypeInUse]
+    arguments: List[Tuple[str, TypeInUse]]
 
     @classmethod
     def parse(cls, item: dict) -> "UtilityFunctionSpec":
@@ -72,7 +72,7 @@ def parse(cls, item: dict) -> "UtilityFunctionSpec":
             category=item["category"],
             is_vararg=item["is_vararg"],
             hash=item["hash"],
-            arguments={x["name"]: TypeInUse(x["type"]) for x in item["arguments"]},
+            arguments=[(correct_name(x["name"]), TypeInUse(x["type"])) for x in item["arguments"]],
         )
 
 

src/godot/_builtins.pyx.j2

@@ -1,4 +1,4 @@
-{%- from '_builtins_pyx/class.j2' import render_spec with context -%}
+{%- from '_builtins_pyx/class.pxi.j2' import render_spec with context -%}
 # /!\ Autogenerated code, modifications will be lost /!\
 # see `scripts/generate_tmpl.py`
 

src/godot/_builtins_pyx/class.j2 renamed to src/godot/_builtins_pyx/class.pxi.j2

@@ -1,5 +1,5 @@
-{%- from '_builtins_pyx/constructor.j2' import render_constructor with context -%}
-{%- from '_builtins_pyx/gdapi.j2' import render_gdapi with context -%}
+{%- from '_builtins_pyx/constructor.pxi.j2' import render_constructor with context -%}
+{%- from '_builtins_pyx/gdapi.pxi.j2' import render_gdapi with context -%}
 
 {% macro render_spec(spec) -%}
 

src/godot/_builtins_pyx/constructor.j2 renamed to src/godot/_builtins_pyx/constructor.pxi.j2

@@ -20,12 +20,47 @@ cdef extern from * nogil:
     cdef const GDNativeInterface *pythonscript_gdapi
 
 
-# Following stuff are all the Godot builtins exposed as:
-# - a C structure (with typed fields if the structure is not opaque)
-# - the function pointer of all the builtin's constructors/destructors/methods/operators
-# - Inlines functions for a nicer way to call the constructors/destructors/methods/operators
+# The following is pretty verbose, here is the tl;dr:
+# - Utility functions exposed as both function pointer and nicer inline function
+# - Builtins as C structure (with typed fields if the structure is not opaque)
+# - Builtins' constructors/destructor/methods/operators exposed as function pointer
+#   and nicer inline function
 
 
+##############################################################################
+#                              Utility functions                             #
+##############################################################################
+{% for spec in api["utility_functions"] %}
+
+# {{ spec.name }}
+cdef GDNativePtrUtilityFunction __utility_{{ spec.name }}
+cdef inline {{ "void" if spec.return_type.is_nil else spec.return_type.c_type }} {{ spec.name }}(
+{%     for arg_name, arg_type in spec.arguments %}
+    {{ arg_type.c_type }}* {{ arg_name }},
+{%     endfor %}
+):
+    cdef GDNativeTypePtr[{{ spec.arguments | length }}] p_args = [{% for arg_name, _ in spec.arguments %}{{ arg_name }},{% endfor %}]
+{%     if not spec.return_type.is_nil %}
+    cdef {{ spec.return_type.c_type }} r_return
+{%     endif %}
+    __utility_{{ spec.name }}(
+        {# GDNativeTypePtr r_return #}
+        {{ "NULL" if spec.return_type.is_nil else "&r_return" }},
+        {# const GDNativeTypePtr *p_arguments #}
+        p_args,
+        {# int p_argument_count #}
+        {{ spec.arguments | length }}
+    )
+{%     if not spec.return_type.is_nil %}
+    return r_return
+{%     endif %}
+{% endfor %}
+
+
+##############################################################################
+#                                  Builtins                                  #
+##############################################################################
+
 cdef struct Variant:
     char _gd_opaque[{{ api.variant_size }}]
 

src/godot/_builtins_pyx/gdapi.j2 renamed to src/godot/_builtins_pyx/gdapi.pxi.j2

@@ -4,14 +4,12 @@
 from .gdnative_interface cimport *
 
 
-{% macro render_arg(arg) -%}
-{{arg.name}}: {{ arg.type.py_type if arg.type.py_type != "GDString" else "GDString | str"}}{{ "={}".format(arg.default_value.value) if arg.default_value is not none }}
-{%- endmacro %}
-
 # Builtins
 {% for spec in api["builtins"] if not spec.is_scalar %}
 
-# {{ spec.name }}
+##############################################################################
+#{{ "{:^76}".format(spec.name) }}#
+##############################################################################
 
 {%   for c in spec.constructors %}
 cdef GDNativePtrConstructor __{{ spec.name }}_constructor_{{ c.index }} = pythonscript_gdapi.variant_get_ptr_constructor(
@@ -39,12 +37,18 @@ cdef GDNativePtrOperatorEvaluator __{{ spec.name }}_op_{{ o.name }} = pythonscri
 
 {% endfor %}
 
-# Utility functions
-{% for spec in api["utility_functions"] %}
+##############################################################################
+#                              Utility functions                             #
+##############################################################################
 
+{% for spec in api["utility_functions"] %}
+# {{ spec.name }}
+cdef GDNativePtrUtilityFunction __utility_{{ spec.name }} = pythonscript_gdapi.variant_get_ptr_utility_function("{{ spec.original_name }}", {{ spec.hash }})
 {% endfor %}
 
-# Classes
+##############################################################################
+#                                   Classes                                  #
+##############################################################################
 {# TODO: do lazy function pointer initialization ? #}
 {% for spec in api["classes"] %}
 

src/godot/_hazmat/gdapi.pxd.j2

@@ -67,9 +67,9 @@ pyx_builtins = custom_target(
         generate_tmpl_base_input,
         files(
             '_builtins.pyx.j2',
-            '_builtins_pyx/class.j2',
-            '_builtins_pyx/constructor.j2',
-            '_builtins_pyx/gdapi.j2',
+            '_builtins_pyx/class.pxi.j2',
+            '_builtins_pyx/constructor.pxi.j2',
+            '_builtins_pyx/gdapi.pxi.j2',
         ),
     ],
     command: generate_tmpl_cmd,