C, implicit tag lookup

Author: jakobandersen

sphinx/domains/c.py

@@ -118,11 +118,6 @@ def __init__(self, identifier: str, tag: Optional[str]) -> None:
         self.identifier = identifier
         self.tag = tag
 
-    def __eq__(self, other: Any) -> bool:
-        return type(other) is ASTIdentifier \
-            and self.identifier == other.identifier \
-            and self.tag == other.tag
-
     def is_anon(self) -> bool:
         return self.identifier[0] == '@'
 
@@ -135,6 +130,13 @@ def get_id(self, version: int) -> str:
         else:
             return self.identifier
 
+    def matches(self, other: "ASTIdentifier") -> bool:
+        if self.identifier != other.identifier:
+            return False
+        if self.tag is None:
+            return True
+        return self.tag == other.tag
+
     # and this is where we finally make a difference between __str__ and the display string
 
     def __str__(self) -> str:
@@ -1685,7 +1687,7 @@ def candidates() -> Generator["Symbol", None, None]:
             if Symbol.debug_lookup:
                 Symbol.debug_print("candidate:")
                 print(s.to_string(Symbol.debug_indent + 1), end="")
-            if s.ident == ident:
+            if s.ident and ident.matches(s.ident):
                 if Symbol.debug_lookup:
                     Symbol.debug_indent += 1
                     Symbol.debug_print("matches")
@@ -1997,11 +1999,11 @@ def find_identifier(self, ident: ASTIdentifier,
                 Symbol.debug_print("trying:")
                 print(current.to_string(Symbol.debug_indent + 1), end="")
                 Symbol.debug_indent -= 2
-            if matchSelf and current.ident == ident:
+            if matchSelf and ident.matches(current.ident):
                 return current
             children = current.children_recurse_anon if recurseInAnon else current._children
             for s in children:
-                if s.ident == ident:
+                if ident.matches(s.ident):
                     return s
             if not searchInSiblings:
                 break
@@ -3764,10 +3766,20 @@ def _resolve_xref_inner(self, env: BuildEnvironment, fromdocname: str, builder:
             assert parentSymbol  # should be there
         else:
             parentSymbol = rootSymbol
+
         s = parentSymbol.find_declaration(name, typ,
                                           matchSelf=True, recurseInAnon=True)
         if s is None or s.declaration is None:
-            return None, None
+            if typ == 'identifier':
+                # these are from within declarations and should be tagged correctly
+                return None, None
+            # but those from xref roles may not have correct tagging
+            name.setTagsToPattern()
+            s = parentSymbol.find_declaration(name, typ,
+                                              matchSelf=True, recurseInAnon=True)
+            if s is None or s.declaration is None:
+                return None, None
+            # TODO: conditionally warn about xrefs with incorrect tagging?
 
         # TODO: check role type vs. object type
 

tests/roots/test-domain-c/ids-vs-tags2.rst

@@ -0,0 +1,12 @@
+.. c:namespace:: @ids_vs_tags2
+
+.. c:struct:: A
+
+   .. c:union:: @data
+
+      .. c:member:: int a
+
+- :c:member:`struct A.union @data.a`
+- :c:member:`A.a`
+- :c:member:`[email protected]`
+- :c:member:`A.a`

tests/roots/test-domain-c/index.rst

@@ -8,7 +8,7 @@ directives
 
    :rtype: int
 
-.. c:function:: MyStruct hello2(char *name)
+.. c:function:: struct MyStruct hello2(char *name)
 
    :rtype: MyStruct
 
@@ -46,7 +46,7 @@ directives
 - :c:expr:`unsigned int`
 - :c:texpr:`unsigned int`
 
-.. c:var:: A a
+.. c:var:: struct A a
 
 - :c:expr:`a->b`
 - :c:texpr:`a->b`

tests/test_domain_c.py

@@ -666,6 +666,13 @@ def test_ids_vs_tags(app, warning):
     assert entries == expected
 
 
+@pytest.mark.sphinx(testroot='domain-c', confoverrides={'nitpicky': True})
+def test_ids_vs_tags2(app, warning):
+    app.builder.build_all()
+    ws = filter_warnings(warning, "ids-vs-tags2")
+    assert len(ws) == 0
+
+
 def test_build_domain_c_semicolon(app, warning):
     text = """
 .. c:member:: int member;