C, initial tag lookup fixes

Author: jakobandersen

sphinx/domains/c.py

@@ -3748,6 +3748,11 @@ def _resolve_xref_inner(self, env: BuildEnvironment, fromdocname: str, builder:
             logger.warning('Unparseable C cross-reference: %r\n%s', target, e,
                            location=node)
             return None, None
+        if typ in ('struct', 'union', 'enum'):
+            last = name.names[-1]
+            if last.tag == '':
+                last.tag = typ
+
         parentKey = node.get("c:parent_key", None)  # type: LookupKey
         rootSymbol = self.data['root_symbol']
         if parentKey:

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

@@ -1,10 +1,27 @@
+.. c:namespace:: @ids_vs_tags
+
 .. c:struct:: f_struct
 .. c:type:: struct f_struct f_struct
 .. c:union:: f_union
-.. c:type:: struct f_union f_union
+.. c:type:: union f_union f_union
 .. c:enum:: f_enum
-.. c:type:: struct f_enum f_enum
+.. c:type:: enum f_enum f_enum
 
-- :c:struct:`f_struct`, :c:type:`f_struct`
-- :c:union:`f_union`, :c:type:`f_union`
-- :c:enum:`f_enum`, :c:type:`f_enum`
+- :c:struct:`f_struct`
+- :c:struct:`struct f_struct`
+- :c:type:`f_struct`
+- :c:type:`struct f_struct`
+- :any:`f_struct`
+- :any:`struct f_struct`
+- :c:union:`f_union`
+- :c:union:`union f_union`
+- :c:type:`f_union`
+- :c:type:`union f_union`
+- :any:`f_union`
+- :any:`union f_union`
+- :c:enum:`f_enum`
+- :c:enum:`enum f_enum`
+- :c:type:`f_enum`
+- :c:type:`enum f_enum`
+- :any:`f_enum`
+- :any:`enum f_enum`

tests/test_domain_c.py

@@ -7,6 +7,7 @@
     :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 """
+
 from xml.etree import ElementTree
 
 import pytest
@@ -626,6 +627,43 @@ def test_ids_vs_tags(app, warning):
     app.builder.build_all()
     ws = filter_warnings(warning, "ids-vs-tags")
     assert len(ws) == 0
+    t = (app.outdir / "ids-vs-tags.html").read_text()
+    lis = [l for l in t.split('\n') if l.startswith("<li")]
+    entries = []
+    for l in lis:
+        li = ElementTree.fromstring(l)
+        assert li.tag == 'li'
+        assert len(li) == 1
+        p = li[0]
+        assert p.tag == 'p'
+        assert len(p) == 1
+        a = p[0]
+        assert a.tag == 'a'
+        target = a.attrib['href'].lstrip('#')
+        title = a.attrib['title']
+        assert len(a) == 1
+        code = a[0]
+        assert code.tag == 'code'
+        text = ''.join(code.itertext())
+        entries.append((target, title, text))
+    expected = []
+    idPrefix = 'C2-@ids_vs_tags.'
+    for tag in ['struct', 'union', 'enum']:
+        name = 'f_' + tag
+        tagTitle = tag + ' ' + name
+        title = name
+        tagTarget = idPrefix + '-' + name
+        target = idPrefix + name
+        # using the designated role
+        expected.append((tagTarget, tagTitle, title))
+        expected.append((tagTarget, tagTitle, tagTitle))
+        # using :c:type:
+        expected.append((target, title, title))
+        expected.append((tagTarget, tagTitle, tagTitle))
+        # using :any:
+        expected.append((target, title, title))
+        expected.append((tagTarget, tagTitle, tagTitle))
+    assert entries == expected
 
 
 def test_build_domain_c_semicolon(app, warning):