Add classes_sample option to compile a subset of Godot classes

Author: touilleMan

meson_options.txt

@@ -1,3 +1,4 @@
 option('cpython_distrib_version', type: 'string', value: '3.10.8', description: 'Version of CPython to ship')
 option('godot_headers', type: 'string', value: 'godot_headers', description: 'Path to Godot extension headers directory')
 option('real_is_double', type: 'boolean', value: false, description: 'Built for Godot with 64bits floating point numbers (i.e. double) in builtins instead of 32bits (i.e. float)')
+option('classes_sample', type: 'boolean', value: false, description: 'Only bind a subset of Godot classes (useful for tests&debug for faster build time)')

scripts/extension_api_parser/api.py

@@ -293,7 +293,7 @@ def order_classes(classes: List[ClassTypeSpec]) -> List[ClassTypeSpec]:
 
 
 def parse_extension_api_json(
-    path: Path, build_config: BuildConfig, skip_classes: bool = False
+    path: Path, build_config: BuildConfig, filter_classes: Union[bool, Set[str]]
 ) -> ExtensionApi:
     api_json = json.loads(path.read_text(encoding="utf8"))
     assert isinstance(api_json, dict)
@@ -327,9 +327,14 @@ def _register_enums(enums, parent_id=None):
         _register_enums(builtin_type.enums, parent_id=builtin_type.original_name)
 
     # Parsing classes takes ~75% of the time while not being needed to render builtins stuff
-    if skip_classes:
+    if filter_classes is True:
         # Only keep Object root class that is always needed
-        api_json["classes"] = [next(k for k in api_json["classes"] if k["name"] == "Object")]
+        filter_classes = {"Object"}
+    if filter_classes:
+        api_json["classes"] = [
+            k for k in api_json["classes"]
+            if k["name"] in filter_classes
+        ]
 
     classes = order_classes(
         [parse_class(x, object_size=api_json["object_size"]) for x in api_json["classes"]]

scripts/generate_tmpl.py

@@ -26,6 +26,80 @@
 }
 
 
+# Subset of tlasses to use when generating the project for test&debug purpose,
+# this makes compilation much faster !
+GODOT_CLASSES_SAMPLE = {
+    "ArrayMesh",
+    "CallbackTweener",
+    "Camera2D",
+    "Camera3D",
+    "CameraAttributes",
+    "CanvasItem",
+    "ClassDB",
+    "ConcavePolygonShape3D",
+    "Control",
+    "ConvexPolygonShape3D",
+    "Engine",
+    "Environment",
+    "Font",
+    "Image",
+    "InputEvent",
+    "IntervalTweener",
+    "MainLoop",
+    "Material",
+    "Mesh",
+    "MethodTweener",
+    "MultiMesh",
+    "MultiplayerAPI",
+    "MultiplayerPeer",
+    "Node",
+    "Node2D",
+    "Node3D",
+    "Node3DGizmo",
+    "OS",
+    "Object",
+    "PackedScene",
+    "PacketPeer",
+    "PhysicsDirectSpaceState2D",
+    "PhysicsDirectSpaceState3D",
+    "PhysicsPointQueryParameters2D",
+    "PhysicsPointQueryParameters3D",
+    "PhysicsRayQueryParameters2D",
+    "PhysicsRayQueryParameters3D",
+    "PhysicsShapeQueryParameters2D",
+    "PhysicsShapeQueryParameters3D",
+    "ProjectSettings",
+    "PropertyTweener",
+    "RefCounted",
+    "Resource",
+    "ResourceFormatLoader",
+    "ResourceFormatSaver",
+    "ResourceImporter",
+    "SceneState",
+    "SceneTree",
+    "SceneTreeTimer",
+    "Script",
+    "ScriptExtension",
+    "ScriptLanguage",
+    "Shape2D",
+    "Shape3D",
+    "Sky",
+    "StyleBox",
+    "TextServer",
+    "Texture",
+    "Texture2D",
+    "Theme",
+    "TriangleMesh",
+    "Tween",
+    "Tweener",
+    "Viewport",
+    "ViewportTexture",
+    "Window",
+    "World2D",
+    "World3D",
+}
+
+
 def make_jinja_env(import_dir: Path) -> Environment:
     env = Environment(
         loader=FileSystemLoader(import_dir),
@@ -48,6 +122,10 @@ def make_jinja_env(import_dir: Path) -> Environment:
         type=Path,
         help="Path to Godot extension_api.json file",
     )
+    parser.add_argument(
+        "--classes-sample",
+        action="store_true",
+    )
     parser.add_argument(
         "--build-config",
         required=True,
@@ -78,8 +156,16 @@ def make_jinja_env(import_dir: Path) -> Environment:
         template_name = f"{name}.j2"
         todo.append((output, template_name, template_home))
 
+    if need_classes:
+        if args.classes_sample:
+            filter_classes = GODOT_CLASSES_SAMPLE
+        else:
+            filter_classes = False  # keep all classes
+    else:
+        filter_classes = True
+
     api = parse_extension_api_json(
-        path=args.input, build_config=BuildConfig(args.build_config), skip_classes=not need_classes
+        path=args.input, build_config=BuildConfig(args.build_config), filter_classes=filter_classes
     )
 
     for todo_output, todo_template_name, todo_template_home in todo:

src/meson.build

@@ -28,6 +28,9 @@ generate_tmpl_cmd = [
     '--output',
     '@OUTPUT0@',
 ]
+if get_option('classes_sample')
+    generate_tmpl_cmd += '--classes-sample'
+endif
 
 
 ##############################################################################