Add support for categories

Differential Revision: D94076350

Author: Dawid Małecki

scripts/cxx-api/parser/builders.py

@@ -25,7 +25,12 @@
     TypedefMember,
     VariableMember,
 )
-from .scope import InterfaceScopeKind, ProtocolScopeKind, StructLikeScopeKind
+from .scope import (
+    CategoryScopeKind,
+    InterfaceScopeKind,
+    ProtocolScopeKind,
+    StructLikeScopeKind,
+)
 from .snapshot import Snapshot
 from .template import Template
 from .utils import (
@@ -539,3 +544,34 @@ def create_class_scope(
             print(
                 f"Unknown class visibility: {visibility} in {compound_object.location.file}"
             )
+
+
+def create_category_scope(
+    snapshot: Snapshot, scope_def: compound.CompounddefType
+) -> None:
+    """
+    Create a category scope in the snapshot (Objective-C category).
+    Categories extend existing classes with additional methods.
+    The compound name is in the format: ClassName(CategoryName)
+    """
+    compound_name = scope_def.compoundname
+
+    # Parse ClassName(CategoryName) format
+    match = re.match(r"^(.+)\((.+)\)$", compound_name)
+    if not match:
+        print(f"Invalid category name format: {compound_name}")
+        return
+
+    class_name = match.group(1)
+    category_name = match.group(2)
+
+    category_scope = snapshot.create_category(class_name, category_name)
+    category_scope.location = scope_def.location.file
+
+    _process_objc_sections(
+        snapshot,
+        category_scope,
+        scope_def.sectiondef,
+        scope_def.location.file,
+        "category",
+    )

scripts/cxx-api/parser/main.py

@@ -14,6 +14,7 @@
 from doxmlparser import compound, index
 
 from .builders import (
+    create_category_scope,
     create_class_scope,
     create_enum_scope,
     create_interface_scope,
@@ -116,7 +117,7 @@ def build_snapshot(xml_dir: str) -> Snapshot:
             elif compound_object.kind == "dir":
                 pass
             elif compound_object.kind == "category":
-                print(f"Category not supported: {compound_object.compoundname}")
+                create_category_scope(snapshot, compound_object)
             elif compound_object.kind == "page":
                 # Contains deprecation info
                 pass

scripts/cxx-api/parser/scope.py

@@ -253,6 +253,28 @@ def to_string(self, scope: Scope) -> str:
         return result
 
 
+class CategoryScopeKind(ScopeKind):
+    def __init__(self, class_name: str, category_name: str) -> None:
+        super().__init__("category")
+        self.class_name: str = class_name
+        self.category_name: str = category_name
+
+    def to_string(self, scope: Scope) -> str:
+        result = f"{self.name} {self.class_name}({self.category_name}) {{"
+
+        stringified_members = []
+        for member in scope.get_members():
+            stringified_members.append(member.to_string(2))
+        stringified_members = natsorted(stringified_members)
+        result += ("\n" if len(stringified_members) > 0 else "") + "\n".join(
+            stringified_members
+        )
+
+        result += "\n}"
+
+        return result
+
+
 class TemporaryScopeKind(ScopeKind):
     def __init__(self) -> None:
         super().__init__("temporary")

scripts/cxx-api/parser/snapshot.py

@@ -6,6 +6,7 @@
 from __future__ import annotations
 
 from .scope import (
+    CategoryScopeKind,
     EnumScopeKind,
     InterfaceScopeKind,
     NamespaceScopeKind,
@@ -134,6 +135,31 @@ def create_interface(self, qualified_name: str) -> Scope[InterfaceScopeKind]:
             current_scope.inner_scopes[scope_name] = new_scope
             return new_scope
 
+    def create_category(
+        self, class_name: str, category_name: str
+    ) -> Scope[CategoryScopeKind]:
+        """
+        Create a category in the snapshot.
+        Categories are stored with a unique key: "ClassName(CategoryName)"
+        """
+        scope_key = f"{class_name}({category_name})"
+        current_scope = self.root_scope
+
+        if scope_key in current_scope.inner_scopes:
+            scope = current_scope.inner_scopes[scope_key]
+            if scope.kind.name == "temporary":
+                scope.kind = CategoryScopeKind(class_name, category_name)
+            else:
+                raise RuntimeError(
+                    f"Identifier {scope_key} already exists in scope {current_scope.name}"
+                )
+            return scope
+        else:
+            new_scope = Scope(CategoryScopeKind(class_name, category_name), scope_key)
+            new_scope.parent_scope = current_scope
+            current_scope.inner_scopes[scope_key] = new_scope
+            return new_scope
+
     def create_enum(self, qualified_name: str) -> Scope[EnumScopeKind]:
         """
         Create an enum in the snapshot.

scripts/cxx-api/tests/snapshots/should_handle_category_empty/snapshot.api

@@ -0,0 +1,5 @@
+category RCTConvert(EmptyCategory) {
+}
+
+interface RCTConvert : public NSObject {
+}

scripts/cxx-api/tests/snapshots/should_handle_category_empty/test.h

@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+@interface RCTConvert : NSObject
+
+@end
+
+@interface RCTConvert (EmptyCategory)
+
+@end

scripts/cxx-api/tests/snapshots/should_handle_category_with_method/snapshot.api

@@ -0,0 +1,7 @@
+category RCTConvert(UIActivityIndicatorView) {
+  public virtual static UIActivityIndicatorViewStyle UIActivityIndicatorViewStyle:(id json);
+}
+
+interface RCTConvert : public NSObject {
+  public virtual static UIActivityIndicatorViewStyle UIActivityIndicatorViewStyle:(id json);
+}

scripts/cxx-api/tests/snapshots/should_handle_category_with_method/test.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+@interface RCTConvert : NSObject
+
+@end
+
+@interface RCTConvert (UIActivityIndicatorView)
+
++ (UIActivityIndicatorViewStyle)UIActivityIndicatorViewStyle:(id)json;
+
+@end

scripts/cxx-api/tests/snapshots/should_handle_category_with_multiple_methods/snapshot.api

@@ -0,0 +1,9 @@
+category RCTConvert(Transform) {
+  public virtual static CATransform3D CATransform3D:(id json);
+  public virtual static RCTTransformOrigin RCTTransformOrigin:(id json);
+}
+
+interface RCTConvert : public NSObject {
+  public virtual static CATransform3D CATransform3D:(id json);
+  public virtual static RCTTransformOrigin RCTTransformOrigin:(id json);
+}

scripts/cxx-api/tests/snapshots/should_handle_category_with_multiple_methods/test.h

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+@interface RCTConvert : NSObject
+
+@end
+
+@interface RCTConvert (Transform)
+
++ (CATransform3D)CATransform3D:(id)json;
++ (RCTTransformOrigin)RCTTransformOrigin:(id)json;
+
+@end