Add C structs bindings to gdapi.pxd

Author: touilleMan

scripts/extension_api_parser/api.py

@@ -9,7 +9,7 @@
 from .type import (
     TYPES_DB,
     TypeInUse,
-    TypeSpec,
+    register_variant_in_types_db,
     register_builtins_in_types_db,
     register_classes_in_types_db,
     register_global_enums_in_types_db,
@@ -221,6 +221,7 @@ def parse_extension_api_json(path: Path, build_config: BuildConfig) -> Extension
     # This is the kind-of ugly part where we register in a global dict the types
     # we've just parsed (so that they could be lazily retreived from all the
     # `TypeInUse` that reference them)
+    register_variant_in_types_db(api.variant_size)
     register_builtins_in_types_db(api.builtins)
     register_classes_in_types_db(api.classes)
     register_global_enums_in_types_db(api.global_enums)

scripts/extension_api_parser/builtins.py

@@ -1,5 +1,5 @@
 import enum
-from typing import Dict, Optional, List
+from typing import Dict, Optional, List, Tuple
 from dataclasses import dataclass
 from string import ascii_uppercase
 
@@ -250,6 +250,7 @@ def parse(cls, item: dict) -> "BuiltinEnumSpec":
 @dataclass
 class BuiltinSpec:
     name: str
+    c_struct_name: str
     original_name: str
     is_scalar: bool
     size: Optional[int]
@@ -264,6 +265,17 @@ class BuiltinSpec:
     variant_type_name: str
     enums: List[BuiltinEnumSpec]
 
+    @property
+    def c_struct_members(self) -> List[Tuple[str, TypeInUse]]:
+        struct_members = [m for m in self.members if m.offset is not None]
+        if struct_members:
+            # Sanity check
+            assert sum(m.type.size for m in struct_members) == self.size
+            return struct_members
+        else:
+            # Opaque structure
+            return []
+
     @classmethod
     def parse(cls, item: dict) -> "BuiltinSpec":
         item["is_scalar"] = item["name"] in ("Nil", "bool", "int", "float")
@@ -276,6 +288,7 @@ def parse(cls, item: dict) -> "BuiltinSpec":
             snake += c
         item["variant_type_name"] = f"GDNATIVE_VARIANT_TYPE_{snake.upper()}"
         item.setdefault("original_name", item["name"])
+        item.setdefault("c_struct_name", f"C{item['original_name']}")
         item.setdefault("indexing_return_type", None)
         item.setdefault("methods", [])
         item.setdefault("members", [])
@@ -287,6 +300,7 @@ def parse(cls, item: dict) -> "BuiltinSpec":
         return cls(
             original_name=item["original_name"],
             name=correct_type_name(item["name"]),
+            c_struct_name=item["c_struct_name"],
             is_scalar=item["is_scalar"],
             size=item["size"],
             indexing_return_type=item["indexing_return_type"],

scripts/extension_api_parser/type.py

@@ -16,6 +16,7 @@
 
 @dataclass
 class TypeSpec:
+    size: int
     # Type used within Godot `extension_api.json`
     gdapi_type: str
     # Type used for PEP 484 Python typing
@@ -58,11 +59,9 @@ def __post_init__(self):
 
 
 TYPES_DB: Dict[str, TypeSpec] = {
-    "Variant": TypeSpec(
-        gdapi_type="Variant", c_type="CVariant", cy_type="object", py_type="GDAny", is_builtin=True
-    ),
     # Types marked as `meta` are used in the classes method args/return types
     "meta:int8": TypeSpec(
+        size=1,
         gdapi_type="int8",
         c_type="int8_t",
         cy_type="int8_t",
@@ -72,6 +71,7 @@ def __post_init__(self):
         is_stack_only=True,
     ),
     "meta:int16": TypeSpec(
+        size=2,
         gdapi_type="int16",
         c_type="int16_t",
         cy_type="int16_t",
@@ -81,6 +81,7 @@ def __post_init__(self):
         is_stack_only=True,
     ),
     "meta:int32": TypeSpec(
+        size=4,
         gdapi_type="int32",
         c_type="int32_t",
         cy_type="int32_t",
@@ -90,6 +91,7 @@ def __post_init__(self):
         is_stack_only=True,
     ),
     "meta:int64": TypeSpec(
+        size=8,
         gdapi_type="int64",
         c_type="int64_t",
         cy_type="int64_t",
@@ -99,6 +101,7 @@ def __post_init__(self):
         is_stack_only=True,
     ),
     "meta:uint8": TypeSpec(
+        size=1,
         gdapi_type="uint8",
         c_type="uint8_t",
         cy_type="uint8_t",
@@ -108,6 +111,7 @@ def __post_init__(self):
         is_stack_only=True,
     ),
     "meta:uint16": TypeSpec(
+        size=2,
         gdapi_type="uint16",
         c_type="uint16_t",
         cy_type="uint16_t",
@@ -117,6 +121,7 @@ def __post_init__(self):
         is_stack_only=True,
     ),
     "meta:uint32": TypeSpec(
+        size=4,
         gdapi_type="uint32",
         c_type="uint32_t",
         cy_type="uint32_t",
@@ -126,6 +131,7 @@ def __post_init__(self):
         is_stack_only=True,
     ),
     "meta:uint64": TypeSpec(
+        size=8,
         gdapi_type="uint64",
         c_type="uint64_t",
         cy_type="uint64_t",
@@ -136,6 +142,7 @@ def __post_init__(self):
     ),
     # int is always 8bytes long
     "int": TypeSpec(
+        size=8,
         gdapi_type="int",
         c_type="uint64_t",
         cy_type="uint64_t",
@@ -145,6 +152,7 @@ def __post_init__(self):
         is_stack_only=True,
     ),
     "meta:float": TypeSpec(
+        size=4,
         gdapi_type="float",
         c_type="float",
         cy_type="float",
@@ -154,6 +162,7 @@ def __post_init__(self):
         is_stack_only=True,
     ),
     "meta:double": TypeSpec(
+        size=8,
         gdapi_type="double",
         c_type="double",
         cy_type="double",
@@ -166,6 +175,17 @@ def __post_init__(self):
 }
 
 
+def register_variant_in_types_db(variant_size: int) -> None:
+    TYPES_DB["Variant"] = TypeSpec(
+        size=variant_size,
+        gdapi_type="Variant",
+        c_type="CVariant",
+        cy_type="object",
+        py_type="GDAny",
+        is_builtin=True,
+    )
+
+
 def register_builtins_in_types_db(builtins: Iterable["BuiltinSpec"]) -> None:
     for spec in builtins:
         if spec.name == "Nil":
@@ -175,6 +195,7 @@ def register_builtins_in_types_db(builtins: Iterable["BuiltinSpec"]) -> None:
             continue
         elif spec.name == "bool":
             ts = TypeSpec(
+                size=spec.size,
                 gdapi_type=spec.original_name,
                 py_type="bool",
                 # Cython provide a `bint` type for boolean, however it is defined in C as
@@ -199,6 +220,7 @@ def register_builtins_in_types_db(builtins: Iterable["BuiltinSpec"]) -> None:
                 ts = replace(TYPES_DB[f"meta:double"], gdapi_type=spec.original_name)
         else:
             ts = TypeSpec(
+                size=spec.size,
                 gdapi_type=spec.original_name,
                 py_type=spec.name,
                 c_type=f"C{spec.name}",
@@ -213,15 +235,19 @@ def register_builtins_in_types_db(builtins: Iterable["BuiltinSpec"]) -> None:
 def register_classes_in_types_db(classes: Iterable["ClassSpec"]) -> None:
     for spec in classes:
         ts = TypeSpec(
+            # Class instance is always manipulated as a pointer,
+            # hence `size` field is never supposed to be used here
+            size=0,  # Dummy value
             gdapi_type=spec.original_name,
             py_type=spec.name,
-            c_type="Object",
-            cy_type="Object",
+            c_type="GDNativeObjectPtr",
+            cy_type="GDNativeObjectPtr",
             variant_type_name="GDNATIVE_VARIANT_TYPE_OBJECT",
         )
         TYPES_DB[ts.gdapi_type] = ts
         for e in spec.enums:
             ts = TypeSpec(
+                size=4,
                 gdapi_type=f"enum::{spec.original_name}.{e.original_name}",
                 py_type=f"{spec.name}.{e.name}",
                 c_type="int",
@@ -237,6 +263,7 @@ def register_classes_in_types_db(classes: Iterable["ClassSpec"]) -> None:
 def register_global_enums_in_types_db(enums: Iterable["GlobalEnumSpec"]) -> None:
     for spec in enums:
         ts = TypeSpec(
+            size=4,
             gdapi_type=f"enum::{spec.original_name}",
             py_type=spec.name,
             c_type="int",
@@ -269,7 +296,10 @@ def resolve(self) -> TypeSpec:
             return
 
     def __getattr__(self, name: str):
-        return getattr(self.resolve(), name)
+        try:
+            return getattr(self.resolve(), name)
+        except AttributeError as exc:
+            raise RuntimeError(f"Error in TypeSpec accessing: {exc}") from exc
 
 
 # ValueInUse is only used to create function argument's default value,

scripts/generate_tmpl.py

@@ -22,6 +22,12 @@ def make_jinja_env(import_dir: Path) -> Environment:
     return env
 
 
+def generate_gdapi_pxd(api: ExtensionApi) -> str:
+    env = make_jinja_env(BASEDIR / "../src/godot/_hazmat")
+    template = env.get_template("gdapi.pxd.j2")
+    return template.render(api=api)
+
+
 def generate_gdapi_ptrs(api: ExtensionApi) -> str:
     env = make_jinja_env(BASEDIR / "../src/godot/_hazmat")
     template = env.get_template("gdapi_ptrs.pxi.j2")
@@ -47,6 +53,7 @@ def generate_builtins_pyi(api: ExtensionApi) -> str:
 
 
 OUTPUT_TO_FN = {
+    "gdapi.pxd": generate_gdapi_pxd,
     "gdapi_ptrs.pxi": generate_gdapi_ptrs,
     "_builtins.pxd": generate_builtins_pxd,
     "_builtins.pyx": generate_builtins_pyx,

src/godot/_hazmat/gdapi.pxd renamed to src/godot/_hazmat/gdapi.pxd.j2

@@ -1,3 +1,4 @@
+from libc.stdint cimport *
 from godot._hazmat.gdnative_interface cimport GDNativeInterface
 
 
@@ -17,3 +18,22 @@ cdef extern from * nogil:
     """
 
     cdef const GDNativeInterface *pythonscript_gdapi
+
+
+cdef struct Variant:
+    char _gd_data[{{ api.variant_size }}]
+
+
+{% for spec in api["builtins"] if not spec.is_scalar %}
+cdef struct {{ spec.c_struct_name }}:
+{%   set c_struct_members = spec.c_struct_members %}
+{%   if c_struct_members %}
+{%     for member in c_struct_members %}
+    {{ member.type.c_type }} {{ member.name }}
+{%     endfor %}
+{%   else %}
+    char _gd_data[{{ spec.size }}]
+{%   endif %}
+
+
+{% endfor %}

src/godot/_hazmat/meson.build

@@ -3,14 +3,23 @@
 ##############################################################################
 
 
-foreach src: ['__init__.py', 'gdapi.pxd']
+foreach src: ['__init__.py']
     install_data(
         src,
         install_dir: join_paths(python_site_packages_install_path, 'godot', '_hazmat'),
     )
 endforeach
 
 
+custom_target(
+    output: 'gdapi.pxd',
+    input: pxd_godot__hazmat_gdapi,
+    command: copy_command,
+    install: true,
+    install_dir: join_paths(python_site_packages_install_path, 'godot', '_hazmat'),
+)
+
+
 custom_target(
     output: 'gdnative_interface.pxd',
     input: pxd_godot__hazmat_gdnative_interface,
@@ -50,10 +59,7 @@ pxi_gdapi_ptrs = custom_target(
 c_gdapi = custom_target(
     output : 'gdapi.c',
     input : [
-        files(
-            'gdapi.pyx',
-            'gdapi.pxd',
-        ),
+        files('gdapi.pyx'),
         pxi_gdapi_ptrs,
         pxds_godot__hazmat,
     ],

src/meson.build

@@ -53,7 +53,6 @@ generate_tmpl_cmd = [
 # godot/_hazmat/gdnative_interface.pxd
 # └─ gdnative_interface.h
 
-
 # Convert the header file frome C to Cython
 pxd_godot__hazmat_gdnative_interface = custom_target(
     output: 'godot#_hazmat#gdnative_interface.pxd',
@@ -65,6 +64,19 @@ pxd_godot__hazmat_gdnative_interface = custom_target(
 )
 
 
+# godot/_hazmat/gdapi.pxd
+# └─ extension_api.json
+
+pxd_godot__hazmat_gdapi = custom_target(
+    output: 'godot#_hazmat#gdapi.pxd',
+    input: [
+        generate_tmpl_base_input,
+        files('godot/_hazmat/gdapi.pxd.j2'),
+    ],
+    command: generate_tmpl_cmd,
+)
+
+
 # godot/builtins.pxd
 # └─ extension_api.json
 
@@ -84,10 +96,8 @@ pxd_godot__builtins = custom_target(
 
 pxds_godot__hazmat = [
     pxd_godot__hazmat_gdnative_interface,
-    files(
-        'godot/_hazmat/__init__.pxd',
-        'godot/_hazmat/gdapi.pxd',
-    ),
+    pxd_godot__hazmat_gdapi,
+    files('godot/_hazmat/__init__.pxd'),
 ]