Symbol tags in SymbolInformation, WorkspaceSymbol, CallHierarchyItem and TypeHierarchyItem by ratzdi · Pull Request #170103 · llvm/llvm-project

ratzdi · 2025-12-01T11:16:32Z

This PR is continuation of #167536.

What is new?

It adds code to compute symbol tags for the following types:
SymbolInformation
WorkspaceSymbol
CallHierarchyItem
TypeHierarchyItem

Calculation of the symbol tags Overrides and Implements
Calculation of symbol tags during the AST creation and embedding them in Symbol.

Minor change on struct Symbol to minimize paddings and thus reducing momory consumption.

Related issues:

github-actions · 2025-12-01T11:16:51Z

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

github-actions · 2026-01-23T14:36:53Z

✅ With the latest revision this PR passed the C/C++ code formatter.

github-actions · 2026-01-23T14:43:51Z

🐧 Linux x64 Test Results

4927 tests passed
7 tests skipped

✅ The build succeeded and all tests passed.

github-actions · 2026-02-27T10:05:13Z

🪟 Windows x64 Test Results

3152 tests passed
30 tests skipped

✅ The build succeeded and all tests passed.

…rarchy.

…rkspace symbols.

in call-hierarchy and type-hierarchy.

Fix code format.

Changed the usage of SymbolTag: - Abstract = pure virtual - Virtual = a virtual method implemented in that class, not implementing or overriding a method from base class - Implements = implements pure virtual method from base class - Override = overriding a virtual method implemented in base class - Final = final method

…ierarchies_and_symbol_info

Apply consistent SymbolTag filtering for indexed C++ methods Introduce `getSymbolTags(const Symbol&)` and use it for index-backed symbol paths so tag filtering is applied consistently outside AST-based code paths. - add `getSymbolTags(const Symbol&)` in `FindSymbols` and document behavior - apply method-specific tag filtering in: - workspace symbols (`FindSymbols.cpp`) - hierarchy items (`XRefs.cpp`) - simplify `filterSymbolTags` to operate on `SymbolTags` only - keep `Declaration`/`Definition` tags for virtual/override/implements cases (only remove tags that are semantically implied, e.g. `Virtual` by `Overrides`/`Implements`/`Abstract`) - update unit tests in `FindSymbolsTests.cpp` and `SymbolCollectorTests.cpp` to assert the new expected tag sets - use `getSymbolTags(...)` in tests instead of directly expanding raw bitmasks - minor cleanup in `SymbolCollector::addDeclaration` tag assignment ordering

Refine filterSymbolTags semantics for method-related tags Improve SymbolTag normalization in `filterSymbolTags` by making tag precedence explicit and handling redundant combinations consistently. Changes: - Introduce local bitmask constants (`Virtual`, `Overrides`, `Implements`, `Abstract`, `Final`) for readability and maintainability. - Keep precedence logic explicit: - `Implements` removes `Overrides` and `Virtual` - `Overrides` removes `Virtual` - `Abstract` removes `Virtual` - `Final` removes redundant `Virtual`/`Overrides` - Align inline comments with actual filtering behavior. This makes tag filtering easier to reason about and avoids inconsistent symbol-tag output for C++ methods.

Replace raw integer-based SymbolTags with a dedicated strong type that is tied to SymbolTag and sanitizes invalid bits. This removes a fragile coupling between SymbolTag and SymbolTags and prevents representing non-existing tags. Update clangd tag logic and serialization paths accordingly: - switch tag construction/checks to SymbolTags::fromTag()/typed operations - keep existing on-disk bit positions compatible - adapt RIFF/YAML serialization to read/write raw SymbolTags storage safely - update serialization tests to use the typed SymbolTags API This improves robustness and maintainability while preserving behavior and backward compatibility of serialized tag values.

- Reused a combined mask (`RemoveVirtualAndOverrides`) to avoid repeating `~(Overrides | Virtual)`. - Merged the two identical "remove virtual" cases (`Overrides`, `Abstract`) into one condition.

This reverts commit bdacf73.

This reverts commit 86a41ca.

timon-ul · 2026-04-28T09:38:35Z

@ratzdi you requested a review but you did not undo the changes we talked about? SymbolTags is still a class. Unless I misunderstood you.

This reverts commit 765ef3e

This reverts commit c39d64b.

timon-ul

Looks good to me now, @HighCommander4 please have a look next :)

timon-ul · 2026-06-30T11:55:03Z

@ArcsinX if you happen to find the time before @HighCommander4 does, it would be appreciated if you could review this.

ArcsinX · 2026-07-06T05:56:28Z

@ArcsinX if you happen to find the time before @HighCommander4 does, it would be appreciated if you could review this.

I plan to take a look this week.

P.S. Sorry for the late reply, I’ve been really busy over the past couple of weeks.

ArcsinX · 2026-07-17T06:07:33Z

@@ -160,6 +161,10 @@ TEST(SerializationTest, YAMLConversions) {
  EXPECT_EQ(static_cast<uint8_t>(Sym1.Flags), 129);
  EXPECT_TRUE(Sym1.Flags & Symbol::IndexedForCodeCompletion);
  EXPECT_FALSE(Sym1.Flags & Symbol::Deprecated);
+  // Tags: Deprecated (1<<1=2) | Static (1<<8=256) = 258
+  EXPECT_EQ(Sym1.Tags, 258u);
+  EXPECT_TRUE(Sym1.Tags & (1u << static_cast<unsigned>(SymbolTag::Deprecated)));


static_cast<unsigned>(SymbolTag::...) appears quite frequently in this PR, but we have toSymbolTagBitmask() function for this. Maybe it's better to use toSymbolTagBitmask()?

ArcsinX · 2026-07-17T06:15:11Z

+// virtual)
+bool isOverrides(const NamedDecl *ND) {
+  if (const auto *MD = llvm::dyn_cast<CXXMethodDecl>(ND)) {
+    if (MD->size_overridden_methods() == 0)


I think we don't need to check MD->size_overridden_methods() here, because at line 150 we have a loop which will be just no-op, if there are not overridden methods.

ArcsinX · 2026-07-17T06:16:50Z

+
+    for (const auto *Overridden : MD->overridden_methods()) {
+      // Check if the overridden method is virtual but not pure virtual
+      if (Overridden->isVirtual() && !Overridden->isPureVirtual())


Instead of checking Overridden->isVirtual() at every loop iteration, we can check MD->isVirtual() before the loop and return false is not.
I mean that Overridden is virtual iff MD is virtual. Maybe inside this loop we can add an assertion for Overridden->isVirtual().
I.e.

check MD->isVirtual() before the loop

add assertion for Overridden->isVirtual() inside the loop

ArcsinX · 2026-07-17T06:18:02Z

+// 3. ALL overridden methods are pure virtual
+bool isImplements(const NamedDecl *ND) {
+  if (const auto *MD = llvm::dyn_cast<CXXMethodDecl>(ND)) {
+    if (MD->size_overridden_methods() == 0 || MD->isPureVirtual())


Same here. I think we don't need to check MD->size_overridden_methods()

ArcsinX · 2026-07-17T06:21:21Z

+  const SymbolTags AbstractMask = toSymbolTagBitmask(SymbolTag::Abstract);
+  const SymbolTags FinalMask = toSymbolTagBitmask(SymbolTag::Final);
+
+  const SymbolTags RemoveVirtualAndOverrides = VirtualMask | OverridesMask;


I think the name of this variable should be VirtualAndOverridesMask, reflecting what it holds.

ratzdi mentioned this pull request Dec 16, 2025

LSP 3.18 - Symbol Tags #167536

Merged

ratzdi force-pushed the users/ratzdi/symbol_tags_in_call_type_hierarchies_and_symbol_info branch 2 times, most recently from 6108868 to 6249e32 Compare January 21, 2026 14:57

ratzdi force-pushed the users/ratzdi/symbol_tags_in_call_type_hierarchies_and_symbol_info branch 3 times, most recently from 5633044 to 96218ec Compare January 25, 2026 21:20

ratzdi marked this pull request as ready for review January 25, 2026 21:26

HighCommander4 requested review from HighCommander4, kadircet and llvm-beanz January 25, 2026 21:30

ratzdi force-pushed the users/ratzdi/symbol_tags_in_call_type_hierarchies_and_symbol_info branch from 96218ec to 79c265d Compare January 25, 2026 21:38

Dimitri Ratz added 10 commits February 27, 2026 11:06

Fill symbol tags for the response TypeHierarchyItem of prepareTypeHie…

910a890

…rarchy.

Fill symbol tags into the object SymbolInformation, and on getting wo…

01a022e

…rkspace symbols.

Minor improvements.

c450d62

Set the detail field of HierarchyItem.

c297add

Collect symbols tags from AST in the method incomingCalls.

35ee021

Collect symbols tags from AST in the method outgoingCalls.

89237d1

Collect symbols tags from AST in the method subtypes.

9eb72dc

Collect symbols tags from AST in the method supertypes.

0b1c3f6

Extended unit-tests to check the occurrence of symbol tags

7e11d69

in call-hierarchy and type-hierarchy.

Simplify lambda capture by explicitly moving Item and parameters.

007764f

Fix code format.

ratzdi force-pushed the users/ratzdi/symbol_tags_in_call_type_hierarchies_and_symbol_info branch from cd4aecb to 007764f Compare February 27, 2026 10:13

ratzdi added 2 commits March 4, 2026 10:40

Feat: compute symbol tags during the AST indexation.

2c0475f

ratzdi force-pushed the users/ratzdi/symbol_tags_in_call_type_hierarchies_and_symbol_info branch from 31a4fd5 to 2c0475f Compare March 5, 2026 14:52

Merge branch 'llvm:main' into users/ratzdi/symbol_tags_in_call_type_h…

525a6ec

…ierarchies_and_symbol_info

travkin79 mentioned this pull request Apr 7, 2026

Add symbol tags as proposed for LSP specification (e.g. visibility tags, static, abstract, etc.) #977 eclipse-lsp4e/lsp4e#1149

Merged

ratzdi force-pushed the users/ratzdi/symbol_tags_in_call_type_hierarchies_and_symbol_info branch from dd4d9fc to 317abd3 Compare April 16, 2026 10:36

ratzdi requested a review from timon-ul April 17, 2026 11:00

timon-ul requested changes Apr 20, 2026

View reviewed changes

Comment thread clang-tools-extra/clangd/FindSymbols.cpp Outdated

timon-ul requested changes Apr 20, 2026

View reviewed changes

Comment thread clang-tools-extra/clangd/index/SymbolCollector.cpp Outdated

Comment thread clang-tools-extra/clangd/FindSymbols.cpp

Comment thread clang-tools-extra/clangd/FindSymbols.cpp

ratzdi added 4 commits April 21, 2026 14:59

Fix: code format.

949f510

Fix: code format.

88aa2a1

ratzdi requested a review from timon-ul April 22, 2026 13:42

timon-ul requested changes Apr 24, 2026

View reviewed changes

ratzdi added 4 commits April 27, 2026 09:39

Replaced toSymbolTagBitmask with SymbolTags::fromTag.

bdacf73

Simplified filterSymbolTags:

86a41ca

- Reused a combined mask (`RemoveVirtualAndOverrides`) to avoid repeating `~(Overrides | Virtual)`. - Merged the two identical "remove virtual" cases (`Overrides`, `Abstract`) into one condition.

Revert "Replaced toSymbolTagBitmask with SymbolTags::fromTag."

2aea848

This reverts commit bdacf73.

Revert "Simplified filterSymbolTags:"

c39d64b

This reverts commit 86a41ca.

ratzdi requested a review from timon-ul April 28, 2026 09:00

Revert "Refactor: Make SymbolTags type-safe and adapt tag handling"

d54d642

This reverts commit 765ef3e

timon-ul requested changes Apr 29, 2026

View reviewed changes

Comment thread clang-tools-extra/clangd/FindSymbols.cpp Outdated

Comment thread clang-tools-extra/clangd/FindSymbols.cpp Outdated

ratzdi added 2 commits April 29, 2026 13:52

Reapply "Simplified filterSymbolTags:"

88b5800

This reverts commit c39d64b.

changed typecast from uint32_t to unsigned.

0ffcf77

timon-ul requested changes Apr 29, 2026

View reviewed changes

Comment thread clang-tools-extra/clangd/FindSymbols.cpp Outdated

changed typecast from uint32_t to unsigned.

c1005bb

timon-ul approved these changes Apr 29, 2026

View reviewed changes

ratzdi requested a review from HighCommander4 April 30, 2026 08:27

ArcsinX self-requested a review July 6, 2026 05:57

ArcsinX reviewed Jul 17, 2026

View reviewed changes

Uh oh!

Conversation

ratzdi commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Dec 1, 2025

Uh oh!

github-actions Bot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🐧 Linux x64 Test Results

Uh oh!

github-actions Bot commented Feb 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🪟 Windows x64 Test Results

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

timon-ul commented Apr 28, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

timon-ul left a comment

Choose a reason for hiding this comment

Uh oh!

timon-ul commented Jun 30, 2026

Uh oh!

ArcsinX commented Jul 6, 2026

Uh oh!

ArcsinX Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

ArcsinX Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

ArcsinX Jul 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ArcsinX Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

ArcsinX Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ratzdi commented Dec 1, 2025 •

edited

Loading

github-actions Bot commented Jan 23, 2026 •

edited

Loading

github-actions Bot commented Jan 23, 2026 •

edited

Loading

github-actions Bot commented Feb 27, 2026 •

edited

Loading

ArcsinX Jul 17, 2026 •

edited

Loading