Improve cross-reference resolution performance in the C++ domain (#11892)

Co-authored-by: Adam Turner <[email protected]>

Author: Rouslan

CHANGES.rst

@@ -24,6 +24,9 @@ Features added
 * #11803: autodoc: Use an overriden ``__repr__()`` function in an enum,
   if defined. Patch by Shengyu Zhang.
 
+* #11892: Improved performance when resolving cross references in cpp domain.
+  Patch by Rouslan Korneychuk.
+
 Bugs fixed
 ----------
 

sphinx/domains/c.py

@@ -149,8 +149,12 @@ def __init__(self, identifier: str) -> None:
         assert len(identifier) != 0
         self.identifier = identifier
 
-    def __eq__(self, other: Any) -> bool:
-        return type(other) is ASTIdentifier and self.identifier == other.identifier
+    # ASTBaseBase already implements this method,
+    # but specialising it here improves performance
+    def __eq__(self, other: object) -> bool:
+        if type(other) is not ASTIdentifier:
+            return NotImplemented
+        return self.identifier == other.identifier
 
     def is_anon(self) -> bool:
         return self.identifier[0] == '@'
@@ -1448,6 +1452,10 @@ def __init__(self, objectType: str, directiveType: str | None,
         # set by CObject._add_enumerator_to_parent
         self.enumeratorScopedSymbol: Symbol | None = None
 
+        # the cache assumes that by the time get_newest_id is called, no
+        # further changes will be made to this object
+        self._newest_id_cache: str | None = None
+
     def clone(self) -> ASTDeclaration:
         return ASTDeclaration(self.objectType, self.directiveType,
                               self.declaration.clone(), self.semicolon)
@@ -1474,7 +1482,9 @@ def get_id(self, version: int, prefixed: bool = True) -> str:
             return id_
 
     def get_newest_id(self) -> str:
-        return self.get_id(_max_id, True)
+        if self._newest_id_cache is None:
+            self._newest_id_cache = self.get_id(_max_id, True)
+        return self._newest_id_cache
 
     def _stringify(self, transform: StringifyTransform) -> str:
         res = transform(self.declaration)

sphinx/domains/cpp.py

@@ -615,6 +615,13 @@ def __init__(self, identifier: str) -> None:
         assert len(identifier) != 0
         self.identifier = identifier
 
+    # ASTBaseBase already implements this method,
+    # but specialising it here improves performance
+    def __eq__(self, other: object) -> bool:
+        if type(other) is not ASTIdentifier:
+            return NotImplemented
+        return self.identifier == other.identifier
+
     def _stringify(self, transform: StringifyTransform) -> str:
         return transform(self.identifier)
 
@@ -4018,6 +4025,10 @@ def __init__(self, objectType: str, directiveType: str | None = None,
         # set by CPPObject._add_enumerator_to_parent
         self.enumeratorScopedSymbol: Symbol | None = None
 
+        # the cache assumes that by the time get_newest_id is called, no
+        # further changes will be made to this object
+        self._newest_id_cache: str | None = None
+
     def clone(self) -> ASTDeclaration:
         templatePrefixClone = self.templatePrefix.clone() if self.templatePrefix else None
         trailingRequiresClasueClone = self.trailingRequiresClause.clone() \
@@ -4083,7 +4094,9 @@ def get_id(self, version: int, prefixed: bool = True) -> str:
         return ''.join(res)
 
     def get_newest_id(self) -> str:
-        return self.get_id(_max_id, True)
+        if self._newest_id_cache is None:
+            self._newest_id_cache = self.get_id(_max_id, True)
+        return self._newest_id_cache
 
     def _stringify(self, transform: StringifyTransform) -> str:
         res = []

sphinx/util/cfamily.py

@@ -88,7 +88,7 @@ class NoOldIdError(Exception):
 
 
 class ASTBaseBase:
-    def __eq__(self, other: Any) -> bool:
+    def __eq__(self, other: object) -> bool:
         if type(self) is not type(other):
             return False
         try:
@@ -145,6 +145,11 @@ def __init__(self, name: str, args: ASTBaseParenExprList | None) -> None:
         self.name = name
         self.args = args
 
+    def __eq__(self, other: object) -> bool:
+        if type(other) is not ASTGnuAttribute:
+            return NotImplemented
+        return self.name == other.name and self.args == other.args
+
     def _stringify(self, transform: StringifyTransform) -> str:
         res = [self.name]
         if self.args:
@@ -204,6 +209,11 @@ class ASTAttributeList(ASTBaseBase):
     def __init__(self, attrs: list[ASTAttribute]) -> None:
         self.attrs = attrs
 
+    def __eq__(self, other: object) -> bool:
+        if type(other) is not ASTAttributeList:
+            return NotImplemented
+        return self.attrs == other.attrs
+
     def __len__(self) -> int:
         return len(self.attrs)