[clangd] Add targetDecl(), which determines what declaration an AST node refers to.

[sammccall]

Summary

This is the first part of an effort to "unbundle" our libIndex use into separate
concerns (AST traversal, token<->node mapping, node<->decl mapping,
decl<->decl relationshipes).

Currently, clangd relies on libIndex to associate tokens, AST nodes, and decls.
This leads to rather convoluted implementations of e.g. hover and
extract-function, which are not naturally thought of as indexing applications.

The idea is that by decoupling different concerns, we make them easier
to use, test, and combine, and more efficient when only one part is needed.
There are some synergies between e.g. traversal and finding
relationships between decls, hopefully the benefits outweight these.

[ilya-biryukov]

Mostly LGTM, thanks! Just a few clarifying questions and suggestions

This API allows us to get a target declaration for a reference, but does not help with finding the source locations for those references. Do you plan to put this into the API? Have this as a separate function?
E.g. finding a source location of field for DeclRefExpr produced for MyBase::field seems to be the same amount of work (in general case) as finding the Decl* of field.

clang-tools-extra/clangd/FindTarget.cpp

374 ↗

(On Diff #217181)

NIT: maybe add braces around multi-line body of the for statement?

clang-tools-extra/clangd/FindTarget.h

70 ↗

(On Diff #217181)

Could we add convenience overloads for Expr*, QualType, TypeLoc and maybe other interesting cases?
Having to call DynTypedNode::create for each invocation of these two functions would feel awkward, saving some typing for the clients seems to be worth a little boilerplate.

86 ↗

(On Diff #217181)

Could you provide examples for Alias and Underlying in the comments?
One with a template and one with a namespace alias

92 ↗

(On Diff #217181)

Could you also provide an example here?
It this a delegating constructor in the constructor-init-list?

103 ↗

(On Diff #217181)

Why not unsigned? What are the interesting corner cases?

[kadircet]

I agree with Ilya's concerns on SourceLocations, even though most of the time user will have the source locations available in the dyntyped node, they might need some traversals to fetch the exact range especially in cases of nested name specifiers.
It would be nice to provide a referencing range in addition to the decls.

clang-tools-extra/clangd/FindTarget.cpp

79 ↗

(On Diff #217181)

nit: s/SD/CRD/

clang-tools-extra/clangd/FindTarget.h

97 ↗

(On Diff #217181)

Could you rather put an end marker into the DeclRelation and make use of it in here? As people might forget to update this one if they add anything into DeclRelation.

(It seems rare for this enum to change though, so feel free to ignore if you believe it will stay the same).

clang-tools-extra/clangd/unittests/FindTargetTests.cpp

49 ↗

(On Diff #217181)

can't you just call A.range() ? :D
I hope it wasn't clangd that somehow code-completed this.

[sammccall]

First a wall of text to reply to the general comments. Let's chat if this doesn't make sense.

In D66751#1646545, @ilya-biryukov wrote:

Mostly LGTM, thanks! Just a few clarifying questions and suggestions

This API allows us to get a target declaration for a reference, but does not help with finding the source locations for those references. Do you plan to put this into the API? Have this as a separate function?

Yes. I actually ripped this out of the patch, because it wasn't related enough and the patch is large.

To restate the relationship between these functions:
Many operations ultimately want to join source location and decl, e.g. gtd is location -> node -> decl, xrefs is decl -> node -> location, indexing is node -> (location, decl).
So providing node->decl and node->location primitives is sufficient. If you want to go in the other direction (decl->node or location->node) then of course you need to traverse and/or build an index.

With that said, there are several legitimate node->location models, and I think this is a good reason to to keep that decoupled from node->decl (testability is another). In particular:

the "flat" model

says that each node may have a token which is its "handle", and each token can be the handle for (refer to) only one node.

int a = X::y;
iii a   X  y

What is the range for a node? Its handle token.
What is the node for a range? The unique handle token covered by the range.

Strengths: accurate, precise triggering on node names. simplicity (conforms to user's view of the code)
Weaknesses: multi-token ranges (selections), implicit nodes (they don't get to have locations), requires specific per-node implementation
Use case: go-to-definition/xrefs triggering, xrefs results (nodes referenced by name)

the "hierarchical" model

says that each node owns a range of tokens, and these nest.

int a = X::y;
        X
        XXX
iii     yyyy
aaaaaaaaaaaa

What is the range for a node? Its full range.
What is the node for a range? The innermost node that entirely contains the selection.

Strengths: exposing underlying structure/hierarchy of the code, can be (mostly) implemented generically
Weaknesses: loose triggering that doesn't distinguish e.g. node names from qualifiers
Use case: extract variable, structured selection, xrefs results (nodes referenced implicitly)

---

I think we're going to need/want both. The hierarchical model corresponds to SelectionTree. The flat model is the thing we need to build. libIndex looks more like the flat model than the hierarchical one, but has elements of both I think.
(If you think the above explanation is useful, we can check something like it in somewhere)

E.g. finding a source location of field for DeclRefExpr produced for MyBase::field seems to be the same amount of work (in general case) as finding the Decl* of field.

For the hierarchical model it's easy, this is one of the few methods DynTypeNode actually has :-)
For the flat model: it's not trivial, but is less work because while you do have to dispatch over all node types, you don't have general multi-hop/graph cases (I think).
Usually the "handle" tokens are well-supported by the AST because they're precisely the ones that diagnostics want to report. So in the DeclRefExpr case, DeclRefExpr::getLoc() returns the right thing.

In D66751#1646675, @kadircet wrote:

I agree with Ilya's concerns on SourceLocations, even though most of the time user will have the source locations available in the dyntyped node, they might need some traversals to fetch the exact range especially in cases of nested name specifiers.

I think if you want the (full) range, this is easy as mentioned above: getSourceRange() (available on DynTypedNode, but also on each specific node type).
If you want just the "handle" token for the flat model, NNS isn't a particularly hard case: it's basically a linked list. Each node claims one component of the NNS as its "handle". If you want to treat NNS as part of the parent (so pointing at X in X::y counts as a ref to Y) then I think you're better off with the hierarchical model.

It would be nice to provide a referencing range in addition to the decls.

Concretely, can you give an example of which node and what you'd want it to point to? If it's just the single unqualified-name token, I agree and would like to add it (as a separate patch). If it's the full range, I think that's getSourceRange(). Is it something else?

[sammccall]

review comments

clang-tools-extra/clangd/FindTarget.cpp

79 ↗

(On Diff #217181)

Done.
(This was copy/pasted from libIndex, I wonder what SD stood for. StructDecl?)

clang-tools-extra/clangd/FindTarget.h

86 ↗

(On Diff #217181)

Done. Added the code example as a section above the values, and the results with the comment on each value - hope this isn't too confusing.

92 ↗

(On Diff #217181)

It was, but it was misguided - the delegating constructor calls have a TypeLoc which references the type being delegated to, so there's not much point handling them I think.

(There would be if we could get the constructor, but we can't: I guess in general it may not be resolved)

This was the only user of PureLexical, so I just removed it.

97 ↗

(On Diff #217181)

Hmm, I'm reluctant to add a "last" member to a strongly-typed enum, and force switch to handle it etc.

I could add it next to the enum, but then it's ugly and still easy enough to miss.

Ultimately, I don't think it's likely this will be missed: bitset::set() checks its argument and throws out_of_range (i.e. aborts) if we try to set an invalid bit. So any test that exercised a new value would crash in all build configs.

103 ↗

(On Diff #217181)

Oops, this dates back to when I was prematurely-templatizing this class. Reverted.

clang-tools-extra/clangd/unittests/FindTargetTests.cpp

49 ↗

(On Diff #217181)

A.range() is an LSP Location (line/col pairs), offsets seem slightly more convenient here.

This is ugly though, using Annotations with SourceLocations seems unneccesarily clunky. Ideas?

(this reminds me, these test helpers need comments, added some)

[kadircet]

Concretely, can you give an example of which node and what you'd want it to point to? If it's just the single unqualified-name token, I agree and would like to add it (as a separate patch). If it's the full range, I think that's getSourceRange(). Is it something else?

Yes I was talking about for the single unqualified name.

clang-tools-extra/clangd/unittests/FindTargetTests.cpp

49 ↗

(On Diff #217181)

ah sorry somehow thought this was already an llvm::Annotations. You seem to be only using Code and Base::range and they are both coming from llvm::Annotations already. Any reason for not using it directly instead of clangd::Annotations ?

[sammccall]

use llvm::Annotations

[ilya-biryukov]

In D66751#1646991, @sammccall wrote:

Yes. I actually ripped this out of the patch, because it wasn't related enough and the patch is large.

Makes sense and thanks for summing it up. Just wanted to make sure we are thinking about this use-case.

My comment was specifically referring to the lack of a "flat" model in our codebase.
I believe hierarchical model is very well handled by the selection tree (there might be bugs, obviously, but conceptually it's doing the right thing).

E.g. finding a source location of field for DeclRefExpr produced for MyBase::field seems to be the same amount of work (in general case) as finding the Decl* of field.

For the hierarchical model it's easy, this is one of the few methods DynTypeNode actually has :-)
For the flat model: it's not trivial, but is less work because while you do have to dispatch over all node types, you don't have general multi-hop/graph cases (I think).
Usually the "handle" tokens are well-supported by the AST because they're precisely the ones that diagnostics want to report. So in the DeclRefExpr case, DeclRefExpr::getLoc() returns the right thing.

To be clear, the concern is not that it's hard to find the corresponding locations for each particular AST node.
The concern is that it's hard to cover all possible nodes and we should do it once rather than repeat this multiple times.

DeclRefExpr was a bad example for that purpose. E.g. one could make the same claim about targetDecl function we are introducing: it's very easy to get a target decl of DeclRefExpr,
but it's hard to enumerate all nodes that can have target decls and ensure they are handled properly.

[sammccall]

fix accidental reverted change

clang-tools-extra/trunk/clangd/CMakeLists.txt

add_clang_library(clangDaemon
   CodeComplete.cpp
   CodeCompletionStrings.cpp
   Compiler.cpp
   Context.cpp
   Diagnostics.cpp
   DraftStore.cpp
   ExpectedTypes.cpp
   FindSymbols.cpp
+  FindTarget.cpp
   FileDistance.cpp
   Format.cpp
   FS.cpp
   FSProvider.cpp
   FormattedString.cpp
   FuzzyMatch.cpp
   GlobalCompilationDatabase.cpp
   Headers.cpp

clang-tools-extra/trunk/clangd/FindTarget.h

+//===--- FindTarget.h - What does an AST node refer to? ---------*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// Many clangd features are concerned with references in the AST:
+//  - xrefs, go-to-definition, explicitly talk about references
+//  - hover and code actions relate to things you "target" in the editor
+//  - refactoring actions need to know about entities that are referenced
+//    to determine whether/how the edit can be applied.
+//
+// Historically, we have used libIndex (IndexDataConsumer) to tie source
+// locations to referenced declarations. This file defines a more decoupled
+// approach based around AST nodes (DynTypedNode), and can be combined with
+// SelectionTree or other traversals.
+//
+//===----------------------------------------------------------------------===//
+
+#include "clang/AST/ASTTypeTraits.h"
+#include "clang/Basic/SourceLocation.h"
+#include "llvm/ADT/SmallPtrSet.h"
+
+#include <bitset>
+
+namespace clang {
+namespace clangd {
+/// Describes the link between an AST node and a Decl it refers to.
+enum class DeclRelation : unsigned;
+/// A bitfield of DeclRelations.
+class DeclRelationSet;
+
+/// targetDecl() finds the declaration referred to by an AST node.
+/// For example a RecordTypeLoc refers to the RecordDecl for the type.
+///
+/// In some cases there are multiple results, e.g. a dependent unresolved
+/// OverloadExpr may have several candidates. All will be returned:
+///
+///    void foo(int);    <-- candidate
+///    void foo(double); <-- candidate
+///    template <typename T> callFoo() { foo(T()); }
+///                                      ^ OverloadExpr
+///
+/// In other cases, there may be choices about what "referred to" means.
+/// e.g. does naming a typedef refer to the underlying type?
+/// The results are marked with a set of DeclRelations, and can be filtered.
+///
+///    struct S{};    <-- candidate (underlying)
+///    using T = S{}; <-- candidate (alias)
+///    T x;
+///    ^ TypedefTypeLoc
+///
+/// Formally, we walk a graph starting at the provided node, and return the
+/// decls that were found. Certain edges in the graph have labels, and for each
+/// decl we return the set of labels seen on a path to the decl.
+/// For the previous example:
+///
+///                TypedefTypeLoc T
+///                       |
+///                 TypedefType T
+///                    /     \
+///           [underlying]  [alias]
+///                  /         \
+///          RecordDecl S    TypeAliasDecl T
+///
+/// FIXME: some AST nodes cannot be DynTypedNodes, these cannot be specified.
+llvm::SmallVector<const Decl *, 1>
+targetDecl(const ast_type_traits::DynTypedNode &, DeclRelationSet Mask);
+
+/// Similar to targetDecl(), however instead of applying a filter, all possible
+/// decls are returned along with their DeclRelationSets.
+/// This is suitable for indexing, where everything is recorded and filtering
+/// is applied later.
+llvm::SmallVector<std::pair<const Decl *, DeclRelationSet>, 1>
+allTargetDecls(const ast_type_traits::DynTypedNode &);
+
+enum class DeclRelation : unsigned {
+  // Template options apply when the declaration is an instantiated template.
+  // e.g. [[vector<int>]] vec;
+
+  /// This is the template instantiation that was referred to.
+  /// e.g. template<> class vector<int> (the implicit specialization)
+  TemplateInstantiation,
+  /// This is the pattern the template specialization was instantiated from.
+  /// e.g. class vector<T> (the pattern within the primary template)
+  TemplatePattern,
+
+  // Alias options apply when the declaration is an alias.
+  // e.g. namespace clang { [[StringRef]] S; }
+
+  /// This declaration is an alias that was referred to.
+  /// e.g. using llvm::StringRef (the UsingDecl directly referenced).
+  Alias,
+  /// This is the underlying declaration for an alias, decltype etc.
+  /// e.g. class llvm::StringRef (the underlying declaration referenced).
+  Underlying,
+};
+llvm::raw_ostream &operator<<(llvm::raw_ostream &, DeclRelation);
+
+class DeclRelationSet {
+  using Set = std::bitset<static_cast<unsigned>(DeclRelation::Underlying) + 1>;
+  Set S;
+  DeclRelationSet(Set S) : S(S) {}
+
+public:
+  DeclRelationSet() = default;
+  DeclRelationSet(DeclRelation R) { S.set(static_cast<unsigned>(R)); }
+
+  explicit operator bool() const { return S.any(); }
+  friend DeclRelationSet operator&(DeclRelationSet L, DeclRelationSet R) {
+    return L.S & R.S;
+  }
+  friend DeclRelationSet operator|(DeclRelationSet L, DeclRelationSet R) {
+    return L.S | R.S;
+  }
+  friend bool operator==(DeclRelationSet L, DeclRelationSet R) {
+    return L.S == R.S;
+  }
+  friend DeclRelationSet operator~(DeclRelationSet R) { return ~R.S; }
+  DeclRelationSet &operator|=(DeclRelationSet Other) {
+    S |= Other.S;
+    return *this;
+  }
+  DeclRelationSet &operator&=(DeclRelationSet Other) {
+    S &= Other.S;
+    return *this;
+  }
+  friend llvm::raw_ostream &operator<<(llvm::raw_ostream &, DeclRelationSet);
+};
+// The above operators can't be looked up if both sides are enums.
+// over.match.oper.html#3.2
+inline DeclRelationSet operator|(DeclRelation L, DeclRelation R) {
+  return DeclRelationSet(L) | DeclRelationSet(R);
+}
+inline DeclRelationSet operator&(DeclRelation L, DeclRelation R) {
+  return DeclRelationSet(L) & DeclRelationSet(R);
+}
+inline DeclRelationSet operator~(DeclRelation R) { return ~DeclRelationSet(R); }
+llvm::raw_ostream &operator<<(llvm::raw_ostream &, DeclRelationSet);
+
+} // namespace clangd
+} // namespace clang

clang-tools-extra/trunk/clangd/FindTarget.cpp

+//===--- FindTarget.cpp - What does an AST node refer to? -----------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "FindTarget.h"
+#include "AST.h"
+#include "Logger.h"
+#include "clang/AST/ASTTypeTraits.h"
+#include "clang/AST/DeclCXX.h"
+#include "clang/AST/DeclTemplate.h"
+#include "clang/AST/DeclVisitor.h"
+#include "clang/AST/DeclarationName.h"
+#include "clang/AST/ExprObjC.h"
+#include "clang/AST/StmtVisitor.h"
+#include "clang/AST/Type.h"
+#include "clang/AST/TypeLocVisitor.h"
+#include "clang/Basic/SourceLocation.h"
+#include "llvm/Support/Casting.h"
+#include "llvm/Support/Compiler.h"
+#include "llvm/Support/raw_ostream.h"
+
+namespace clang {
+namespace clangd {
+namespace {
+
+LLVM_DUMP_METHOD std::string
+nodeToString(const ast_type_traits::DynTypedNode &N) {
+  std::string S = N.getNodeKind().asStringRef();
+  {
+    llvm::raw_string_ostream OS(S);
+    OS << ": ";
+    N.print(OS, PrintingPolicy(LangOptions()));
+  }
+  std::replace(S.begin(), S.end(), '\n', ' ');
+  return S;
+}
+
+// TargetFinder locates the entities that an AST node refers to.
+//
+// Typically this is (possibly) one declaration and (possibly) one type, but
+// may be more:
+//  - for ambiguous nodes like OverloadExpr
+//  - if we want to include e.g. both typedefs and the underlying type
+//
+// This is organized as a set of mutually recursive helpers for particular node
+// types, but for most nodes this is a short walk rather than a deep traversal.
+//
+// It's tempting to do e.g. typedef resolution as a second normalization step,
+// after finding the 'primary' decl etc. But we do this monolithically instead
+// because:
+//  - normalization may require these traversals again (e.g. unwrapping a
+//    typedef reveals a decltype which must be traversed)
+//  - it doesn't simplify that much, e.g. the first stage must still be able
+//    to yield multiple decls to handle OverloadExpr
+//  - there are cases where it's required for correctness. e.g:
+//      template<class X> using pvec = vector<x*>; pvec<int> x;
+//    There's no Decl `pvec<int>`, we must choose `pvec<X>` or `vector<int*>`
+//    and both are lossy. We must know upfront what the caller ultimately wants.
+//
+// FIXME: improve common dependent scope using name lookup in primary templates.
+// e.g. template<typename T> int foo() { return std::vector<T>().size(); }
+// formally size() is unresolved, but the primary template is a good guess.
+// This affects:
+//  - DependentTemplateSpecializationType,
+//  - DependentScopeMemberExpr
+//  - DependentScopeDeclRefExpr
+//  - DependentNameType
+struct TargetFinder {
+  using RelSet = DeclRelationSet;
+  using Rel = DeclRelation;
+  llvm::SmallDenseMap<const Decl *, RelSet> Decls;
+  RelSet Flags;
+
+  static const Decl *getTemplatePattern(const Decl *D) {
+    if (const CXXRecordDecl *CRD = dyn_cast<CXXRecordDecl>(D)) {
+      return CRD->getTemplateInstantiationPattern();
+    } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
+      return FD->getTemplateInstantiationPattern();
+    } else if (auto *VD = dyn_cast<VarDecl>(D)) {
+      // Hmm: getTIP returns its arg if it's not an instantiation?!
+      VarDecl *T = VD->getTemplateInstantiationPattern();
+      return (T == D) ? nullptr : T;
+    } else if (const auto *ED = dyn_cast<EnumDecl>(D)) {
+      return ED->getInstantiatedFromMemberEnum();
+    } else if (isa<FieldDecl>(D) || isa<TypedefNameDecl>(D)) {
+      const auto *ND = cast<NamedDecl>(D);
+      if (const DeclContext *Parent = dyn_cast_or_null<DeclContext>(
+              getTemplatePattern(llvm::cast<Decl>(ND->getDeclContext()))))
+        for (const NamedDecl *BaseND : Parent->lookup(ND->getDeclName()))
+          if (!BaseND->isImplicit() && BaseND->getKind() == ND->getKind())
+            return BaseND;
+    } else if (const auto *ECD = dyn_cast<EnumConstantDecl>(D)) {
+      if (const auto *ED = dyn_cast<EnumDecl>(ECD->getDeclContext())) {
+        if (const EnumDecl *Pattern = ED->getInstantiatedFromMemberEnum()) {
+          for (const NamedDecl *BaseECD : Pattern->lookup(ECD->getDeclName()))
+            return BaseECD;
+        }
+      }
+    }
+    return nullptr;
+  }
+
+  template <typename T> void debug(T &Node, RelSet Flags) {
+    dlog("visit [{0}] {1}", Flags,
+         nodeToString(ast_type_traits::DynTypedNode::create(Node)));
+  }
+
+  void report(const Decl *D, RelSet Flags) {
+    dlog("--> [{0}] {1}", Flags,
+         nodeToString(ast_type_traits::DynTypedNode::create(*D)));
+    Decls[D] |= Flags;
+  }
+
+public:
+  void add(const Decl *D, RelSet Flags) {
+    if (!D)
+      return;
+    debug(*D, Flags);
+    if (const UsingDirectiveDecl *UDD = llvm::dyn_cast<UsingDirectiveDecl>(D))
+      D = UDD->getNominatedNamespaceAsWritten();
+
+    if (const TypedefNameDecl *TND = dyn_cast<TypedefNameDecl>(D)) {
+      add(TND->getUnderlyingType(), Flags | Rel::Underlying);
+      Flags |= Rel::Alias; // continue with the alias.
+    } else if (const UsingDecl *UD = dyn_cast<UsingDecl>(D)) {
+      for (const UsingShadowDecl *S : UD->shadows())
+        add(S->getUnderlyingDecl(), Flags | Rel::Underlying);
+      Flags |= Rel::Alias; // continue with the alias.
+    } else if (const auto *NAD = dyn_cast<NamespaceAliasDecl>(D)) {
+      add(NAD->getUnderlyingDecl(), Flags | Rel::Underlying);
+      Flags |= Rel::Alias; // continue with the alias
+    } else if (const UsingShadowDecl *USD = dyn_cast<UsingShadowDecl>(D)) {
+      // Include the using decl, but don't traverse it. This may end up
+      // including *all* shadows, which we don't want.
+      report(USD->getUsingDecl(), Flags | Rel::Alias);
+      // Shadow decls are synthetic and not themselves interesting.
+      // Record the underlying decl instead, if allowed.
+      D = USD->getTargetDecl();
+      Flags |= Rel::Underlying; // continue with the underlying decl.
+    }
+
+    if (const Decl *Pat = getTemplatePattern(D)) {
+      assert(Pat != D);
+      add(Pat, Flags | Rel::TemplatePattern);
+      // Now continue with the instantiation.
+      Flags |= Rel::TemplateInstantiation;
+    }
+
+    report(D, Flags);
+  }
+
+  void add(const Stmt *S, RelSet Flags) {
+    if (!S)
+      return;
+    debug(*S, Flags);
+    struct Visitor : public ConstStmtVisitor<Visitor> {
+      TargetFinder &Outer;
+      RelSet Flags;
+      Visitor(TargetFinder &Outer, RelSet Flags) : Outer(Outer), Flags(Flags) {}
+
+      void VisitDeclRefExpr(const DeclRefExpr *DRE) {
+        const Decl *D = DRE->getDecl();
+        // UsingShadowDecl allows us to record the UsingDecl.
+        // getFoundDecl() returns the wrong thing in other cases (templates).
+        if (auto *USD = llvm::dyn_cast<UsingShadowDecl>(DRE->getFoundDecl()))
+          D = USD;
+        Outer.add(D, Flags);
+      }
+      void VisitMemberExpr(const MemberExpr *ME) {
+        const Decl *D = ME->getMemberDecl();
+        if (auto *USD =
+                llvm::dyn_cast<UsingShadowDecl>(ME->getFoundDecl().getDecl()))
+          D = USD;
+        Outer.add(D, Flags);
+      }
+      void VisitCXXConstructExpr(const CXXConstructExpr *CCE) {
+        Outer.add(CCE->getConstructor(), Flags);
+      }
+      void VisitDesignatedInitExpr(const DesignatedInitExpr *DIE) {
+        for (const DesignatedInitExpr::Designator &D :
+             llvm::reverse(DIE->designators()))
+          if (D.isFieldDesignator()) {
+            Outer.add(D.getField(), Flags);
+            // We don't know which designator was intended, we assume the outer.
+            break;
+          }
+      }
+      void VisitObjCIvarRefExpr(const ObjCIvarRefExpr *OIRE) {
+        Outer.add(OIRE->getDecl(), Flags);
+      }
+      void VisitObjCMessageExpr(const ObjCMessageExpr *OME) {
+        Outer.add(OME->getMethodDecl(), Flags);
+      }
+      void VisitObjCPropertyRefExpr(const ObjCPropertyRefExpr *OPRE) {
+        if (OPRE->isExplicitProperty())
+          Outer.add(OPRE->getExplicitProperty(), Flags);
+        else {
+          if (OPRE->isMessagingGetter())
+            Outer.add(OPRE->getImplicitPropertyGetter(), Flags);
+          if (OPRE->isMessagingSetter())
+            Outer.add(OPRE->getImplicitPropertySetter(), Flags);
+        }
+      }
+      void VisitObjCProtocolExpr(const ObjCProtocolExpr *OPE) {
+        Outer.add(OPE->getProtocol(), Flags);
+      }
+    };
+    Visitor(*this, Flags).Visit(S);
+  }
+
+  void add(QualType T, RelSet Flags) {
+    if (T.isNull())
+      return;
+    debug(T, Flags);
+    struct Visitor : public TypeVisitor<Visitor> {
+      TargetFinder &Outer;
+      RelSet Flags;
+      Visitor(TargetFinder &Outer, RelSet Flags) : Outer(Outer), Flags(Flags) {}
+
+      void VisitTagType(const TagType *TT) {
+        Outer.add(TT->getAsTagDecl(), Flags);
+      }
+      void VisitDecltypeType(const DecltypeType *DTT) {
+        Outer.add(DTT->getUnderlyingType(), Flags | Rel::Underlying);
+      }
+      void VisitDeducedType(const DeducedType *DT) {
+        // FIXME: In practice this doesn't work: the AutoType you find inside
+        // TypeLoc never has a deduced type. https://llvm.org/PR42914
+        Outer.add(DT->getDeducedType(), Flags | Rel::Underlying);
+      }
+      void VisitTypedefType(const TypedefType *TT) {
+        Outer.add(TT->getDecl(), Flags);
+      }
+      void
+      VisitTemplateSpecializationType(const TemplateSpecializationType *TST) {
+        // Have to handle these case-by-case.
+
+        // templated type aliases: there's no specialized/instantiated using
+        // decl to point to. So try to find a decl for the underlying type
+        // (after substitution), and failing that point to the (templated) using
+        // decl.
+        if (TST->isTypeAlias()) {
+          Outer.add(TST->getAliasedType(), Flags | Rel::Underlying);
+          // Don't *traverse* the alias, which would result in traversing the
+          // template of the underlying type.
+          Outer.report(
+              TST->getTemplateName().getAsTemplateDecl()->getTemplatedDecl(),
+              Flags | Rel::Alias | Rel::TemplatePattern);
+        }
+        // specializations of template template parameters aren't instantiated
+        // into decls, so they must refer to the parameter itself.
+        else if (const auto *Parm =
+                     llvm::dyn_cast_or_null<TemplateTemplateParmDecl>(
+                         TST->getTemplateName().getAsTemplateDecl()))
+          Outer.add(Parm, Flags);
+        // class template specializations have a (specialized) CXXRecordDecl.
+        else if (const CXXRecordDecl *RD = TST->getAsCXXRecordDecl())
+          Outer.add(RD, Flags); // add(Decl) will despecialize if needed.
+        else {
+          // fallback: the (un-specialized) declaration from primary template.
+          if (auto *TD = TST->getTemplateName().getAsTemplateDecl())
+            Outer.add(TD->getTemplatedDecl(), Flags | Rel::TemplatePattern);
+        }
+      }
+      void VisitTemplateTypeParmType(const TemplateTypeParmType *TTPT) {
+        Outer.add(TTPT->getDecl(), Flags);
+      }
+      void VisitObjCInterfaceType(const ObjCInterfaceType *OIT) {
+        Outer.add(OIT->getDecl(), Flags);
+      }
+      void VisitObjCObjectType(const ObjCObjectType *OOT) {
+        // FIXME: ObjCObjectTypeLoc has no children for the protocol list, so
+        // there is no node in id<Foo> that refers to ObjCProtocolDecl Foo.
+        if (OOT->isObjCQualifiedId() && OOT->getNumProtocols() == 1)
+          Outer.add(OOT->getProtocol(0), Flags);
+      }
+    };
+    Visitor(*this, Flags).Visit(T.getTypePtr());
+  }
+
+  void add(const NestedNameSpecifier *NNS, RelSet Flags) {
+    if (!NNS)
+      return;
+    debug(*NNS, Flags);
+    switch (NNS->getKind()) {
+    case NestedNameSpecifier::Identifier:
+      return;
+    case NestedNameSpecifier::Namespace:
+      add(NNS->getAsNamespace(), Flags);
+      return;
+    case NestedNameSpecifier::NamespaceAlias:
+      add(NNS->getAsNamespaceAlias(), Flags);
+      return;
+    case NestedNameSpecifier::TypeSpec:
+    case NestedNameSpecifier::TypeSpecWithTemplate:
+      add(QualType(NNS->getAsType(), 0), Flags);
+      return;
+    case NestedNameSpecifier::Global:
+      // This should be TUDecl, but we can't get a pointer to it!
+      return;
+    case NestedNameSpecifier::Super:
+      add(NNS->getAsRecordDecl(), Flags);
+      return;
+    }
+    llvm_unreachable("unhandled NestedNameSpecifier::SpecifierKind");
+  }
+
+  void add(const CXXCtorInitializer *CCI, RelSet Flags) {
+    if (!CCI)
+      return;
+    debug(*CCI, Flags);
+
+    if (CCI->isAnyMemberInitializer())
+      add(CCI->getAnyMember(), Flags);
+    // Constructor calls contain a TypeLoc node, so we don't handle them here.
+  }
+};
+
+} // namespace
+
+llvm::SmallVector<std::pair<const Decl *, DeclRelationSet>, 1>
+allTargetDecls(const ast_type_traits::DynTypedNode &N) {
+  dlog("allTargetDecls({0})", nodeToString(N));
+  TargetFinder Finder;
+  DeclRelationSet Flags;
+  if (const Decl *D = N.get<Decl>())
+    Finder.add(D, Flags);
+  else if (const Stmt *S = N.get<Stmt>())
+    Finder.add(S, Flags);
+  else if (const NestedNameSpecifierLoc *NNSL = N.get<NestedNameSpecifierLoc>())
+    Finder.add(NNSL->getNestedNameSpecifier(), Flags);
+  else if (const NestedNameSpecifier *NNS = N.get<NestedNameSpecifier>())
+    Finder.add(NNS, Flags);
+  else if (const TypeLoc *TL = N.get<TypeLoc>())
+    Finder.add(TL->getType(), Flags);
+  else if (const QualType *QT = N.get<QualType>())
+    Finder.add(*QT, Flags);
+  else if (const CXXCtorInitializer *CCI = N.get<CXXCtorInitializer>())
+    Finder.add(CCI, Flags);
+
+  return {Finder.Decls.begin(), Finder.Decls.end()};
+}
+
+llvm::SmallVector<const Decl *, 1>
+targetDecl(const ast_type_traits::DynTypedNode &N, DeclRelationSet Mask) {
+  llvm::SmallVector<const Decl *, 1> Result;
+  for (const auto &Entry : allTargetDecls(N))
+    if (!(Entry.second & ~Mask))
+      Result.push_back(Entry.first);
+  return Result;
+}
+
+llvm::raw_ostream &operator<<(llvm::raw_ostream &OS, DeclRelation R) {
+  switch (R) {
+#define REL_CASE(X)                                                            \
+  case DeclRelation::X:                                                        \
+    return OS << #X;
+    REL_CASE(Alias);
+    REL_CASE(Underlying);
+    REL_CASE(TemplateInstantiation);
+    REL_CASE(TemplatePattern);
+#undef REL_CASE
+  };
+}
+llvm::raw_ostream &operator<<(llvm::raw_ostream &OS, DeclRelationSet RS) {
+  const char *Sep = "";
+  for (unsigned I = 0; I < RS.S.size(); ++I) {
+    if (RS.S.test(I)) {
+      OS << Sep << static_cast<DeclRelation>(I);
+      Sep = "|";
+    }
+  }
+  return OS;
+}
+
+} // namespace clangd
+} // namespace clang

clang-tools-extra/trunk/clangd/unittests/ASTTests.cpp

ASSERT_EQ(
       "testns2::TestClass",
       shortenNamespace("testns1::testns2::TestClass", "testns1"));
 
   ASSERT_EQ("TestClass<testns1::OtherClass>",
             shortenNamespace(
                 "testns1::TestClass<testns1::OtherClass>", "testns1"));
 }
 
-
 } // namespace
 } // namespace clangd
 } // namespace clang

clang-tools-extra/trunk/clangd/unittests/CMakeLists.txt

add_unittest(ClangdUnitTests ClangdTests
   ContextTests.cpp
   DexTests.cpp
   DiagnosticsTests.cpp
   DraftStoreTests.cpp
   ExpectedTypeTest.cpp
   FileDistanceTests.cpp
   FileIndexTests.cpp
   FindSymbolsTests.cpp
+  FindTargetTests.cpp
   FormattedStringTests.cpp
   FormatTests.cpp
   FSTests.cpp
   FunctionTests.cpp
   FuzzyMatchTests.cpp
   GlobalCompilationDatabaseTests.cpp
   HeadersTests.cpp
   IndexActionTests.cpp

clang-tools-extra/trunk/clangd/unittests/FindTargetTests.cpp

+//===-- FindSymbolsTests.cpp -------------------------*- C++ -*------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+#include "FindTarget.h"
+
+#include "Selection.h"
+#include "TestTU.h"
+#include "llvm/Support/raw_ostream.h"
+#include "llvm/Testing/Support/Annotations.h"
+#include "gmock/gmock.h"
+#include "gtest/gtest.h"
+#include <initializer_list>
+
+namespace clang {
+namespace clangd {
+namespace {
+
+// A referenced Decl together with its DeclRelationSet, for assertions.
+//
+// There's no great way to assert on the "content" of a Decl in the general case
+// that's both expressive and unambiguous (e.g. clearly distinguishes between
+// templated decls and their specializations).
+//
+// We use the result of pretty-printing the decl, with the {body} truncated.
+struct PrintedDecl {
+  PrintedDecl(const char *Name, DeclRelationSet Relations = {})
+      : Name(Name), Relations(Relations) {}
+  PrintedDecl(const Decl *D, DeclRelationSet Relations = {})
+      : Relations(Relations) {
+    std::string S;
+    llvm::raw_string_ostream OS(S);
+    D->print(OS);
+    llvm::StringRef FirstLine =
+        llvm::StringRef(OS.str()).take_until([](char C) { return C == '\n'; });
+    FirstLine = FirstLine.rtrim(" {");
+    Name = FirstLine.rtrim(" {");
+  }
+
+  std::string Name;
+  DeclRelationSet Relations;
+};
+bool operator==(const PrintedDecl &L, const PrintedDecl &R) {
+  return std::tie(L.Name, L.Relations) == std::tie(R.Name, R.Relations);
+}
+llvm::raw_ostream &operator<<(llvm::raw_ostream &OS, const PrintedDecl &D) {
+  return OS << D.Name << " Rel=" << D.Relations;
+}
+
+// The test cases in for targetDecl() take the form
+//  - a piece of code (Code = "...")
+//  - Code should have a single AST node marked as a [[range]]
+//  - an EXPECT_DECLS() assertion that verify the type of node selected, and
+//    all the decls that targetDecl() considers it to reference
+// Despite the name, these cases actually test allTargetDecls() for brevity.
+class TargetDeclTest : public ::testing::Test {
+protected:
+  using Rel = DeclRelation;
+  std::string Code;
+  std::vector<const char *> Flags;
+
+  // Asserts that `Code` has a marked selection of a node `NodeType`,
+  // and returns allTargetDecls() as PrintedDecl structs.
+  // Use via EXPECT_DECLS().
+  std::vector<PrintedDecl> assertNodeAndPrintDecls(const char *NodeType) {
+    llvm::Annotations A(Code);
+    auto TU = TestTU::withCode(A.code());
+    TU.ExtraArgs = Flags;
+    auto AST = TU.build();
+    EXPECT_THAT(AST.getDiagnostics(), ::testing::IsEmpty()) << Code;
+    llvm::Annotations::Range R = A.range();
+    SelectionTree Selection(AST.getASTContext(), AST.getTokens(), R.Begin,
+                            R.End);
+    const SelectionTree::Node *N = Selection.commonAncestor();
+    if (!N) {
+      ADD_FAILURE() << "No node selected!\n" << Code;
+      return {};
+    }
+    EXPECT_EQ(N->kind(), NodeType) << Selection;
+
+    std::vector<PrintedDecl> ActualDecls;
+    for (const auto &Entry : allTargetDecls(N->ASTNode))
+      ActualDecls.emplace_back(Entry.first, Entry.second);
+    return ActualDecls;
+  }
+};
+
+// This is a macro to preserve line numbers in assertion failures.
+// It takes the expected decls as varargs to work around comma-in-macro issues.
+#define EXPECT_DECLS(NodeType, ...)                                            \
+  EXPECT_THAT(assertNodeAndPrintDecls(NodeType),                               \
+              ::testing::UnorderedElementsAreArray(                            \
+                  std::vector<PrintedDecl>({__VA_ARGS__})))                    \
+      << Code
+using ExpectedDecls = std::vector<PrintedDecl>;
+
+TEST_F(TargetDeclTest, Exprs) {
+  Code = R"cpp(
+    int f();
+    int x = [[f]]();
+  )cpp";
+  EXPECT_DECLS("DeclRefExpr", "int f()");
+
+  Code = R"cpp(
+    struct S { S operator+(S) const; };
+    auto X = S() [[+]] S();
+  )cpp";
+  EXPECT_DECLS("DeclRefExpr", "S operator+(S) const");
+}
+
+TEST_F(TargetDeclTest, UsingDecl) {
+  Code = R"cpp(
+    namespace foo {
+      int f(int);
+      int f(char);
+    }
+    using foo::f;
+    int x = [[f]](42);
+  )cpp";
+  // f(char) is not referenced!
+  EXPECT_DECLS("DeclRefExpr", {"using foo::f", Rel::Alias},
+               {"int f(int)", Rel::Underlying});
+
+  Code = R"cpp(
+    namespace foo {
+      int f(int);
+      int f(char);
+    }
+    [[using foo::f]];
+  )cpp";
+  // All overloads are referenced.
+  EXPECT_DECLS("UsingDecl", {"using foo::f", Rel::Alias},
+               {"int f(int)", Rel::Underlying},
+               {"int f(char)", Rel::Underlying});
+
+  Code = R"cpp(
+    struct X {
+      int foo();
+    };
+    struct Y : X {
+      using X::foo;
+    };
+    int x = Y().[[foo]]();
+  )cpp";
+  EXPECT_DECLS("MemberExpr", {"using X::foo", Rel::Alias},
+               {"int foo()", Rel::Underlying});
+}
+
+TEST_F(TargetDeclTest, ConstructorInitList) {
+  Code = R"cpp(
+    struct X {
+      int a;
+      X() : [[a]](42) {}
+    };
+  )cpp";
+  EXPECT_DECLS("CXXCtorInitializer", "int a");
+
+  Code = R"cpp(
+    struct X {
+      X() : [[X]](1) {}
+      X(int);
+    };
+  )cpp";
+  EXPECT_DECLS("RecordTypeLoc", "struct X");
+}
+
+TEST_F(TargetDeclTest, DesignatedInit) {
+  Flags = {"-xc"}; // array designators are a C99 extension.
+  Code = R"c(
+    struct X { int a; };
+    struct Y { int b; struct X c[2]; };
+    struct Y y = { .c[0].[[a]] = 1 };
+  )c";
+  EXPECT_DECLS("DesignatedInitExpr", "int a");
+}
+
+TEST_F(TargetDeclTest, NestedNameSpecifier) {
+  Code = R"cpp(
+    namespace a { namespace b { int c; } }
+    int x = a::[[b::]]c;
+  )cpp";
+  EXPECT_DECLS("NestedNameSpecifierLoc", "namespace b");
+
+  Code = R"cpp(
+    namespace a { struct X { enum { y }; }; }
+    int x = a::[[X::]]y;
+  )cpp";
+  EXPECT_DECLS("NestedNameSpecifierLoc", "struct X");
+
+  Code = R"cpp(
+    template <typename T>
+    int x = [[T::]]y;
+  )cpp";
+  // FIXME: We don't do a good job printing TemplateTypeParmDecls, apparently!
+  EXPECT_DECLS("NestedNameSpecifierLoc", "");
+
+  Code = R"cpp(
+    namespace a { int x; }
+    namespace b = a;
+    int y = [[b]]::x;
+  )cpp";
+  EXPECT_DECLS("NestedNameSpecifierLoc", {"namespace b = a", Rel::Alias},
+               {"namespace a", Rel::Underlying});
+}
+
+TEST_F(TargetDeclTest, Types) {
+  Code = R"cpp(
+    struct X{};
+    [[X]] x;
+  )cpp";
+  EXPECT_DECLS("RecordTypeLoc", "struct X");
+
+  Code = R"cpp(
+    struct S{};
+    typedef S X;
+    [[X]] x;
+  )cpp";
+  EXPECT_DECLS("TypedefTypeLoc", {"typedef S X", Rel::Alias},
+               {"struct S", Rel::Underlying});
+
+  Code = R"cpp(
+    template<class T>
+    void foo() { [[T]] x; }
+  )cpp";
+  // FIXME: We don't do a good job printing TemplateTypeParmDecls, apparently!
+  EXPECT_DECLS("TemplateTypeParmTypeLoc", "");
+
+  Code = R"cpp(
+    template<template<typename> class T>
+    void foo() { [[T<int>]] x; }
+  )cpp";
+  EXPECT_DECLS("TemplateSpecializationTypeLoc", "template <typename> class T");
+
+  Code = R"cpp(
+    struct S{};
+    S X;
+    [[decltype]](X) Y;
+  )cpp";
+  EXPECT_DECLS("DecltypeTypeLoc", {"struct S", Rel::Underlying});
+
+  Code = R"cpp(
+    struct S{};
+    [[auto]] X = S{};
+  )cpp";
+  // FIXME: deduced type missing in AST. https://llvm.org/PR42914
+  EXPECT_DECLS("AutoTypeLoc");
+}
+
+TEST_F(TargetDeclTest, ClassTemplate) {
+  Code = R"cpp(
+    // Implicit specialization.
+    template<int x> class Foo{};
+    [[Foo<42>]] B;
+  )cpp";
+  EXPECT_DECLS("TemplateSpecializationTypeLoc",
+               {"template<> class Foo<42>", Rel::TemplateInstantiation},
+               {"class Foo", Rel::TemplatePattern});
+
+  Code = R"cpp(
+    // Explicit specialization.
+    template<int x> class Foo{};
+    template<> class Foo<42>{};
+    [[Foo<42>]] B;
+  )cpp";
+  EXPECT_DECLS("TemplateSpecializationTypeLoc", "template<> class Foo<42>");
+
+  Code = R"cpp(
+    // Partial specialization.
+    template<typename T> class Foo{};
+    template<typename T> class Foo<T*>{};
+    [[Foo<int*>]] B;
+  )cpp";
+  EXPECT_DECLS("TemplateSpecializationTypeLoc",
+               {"template<> class Foo<int *>", Rel::TemplateInstantiation},
+               {"template <typename T> class Foo<type-parameter-0-0 *>",
+                Rel::TemplatePattern});
+}
+
+TEST_F(TargetDeclTest, FunctionTemplate) {
+  Code = R"cpp(
+    // Implicit specialization.
+    template<typename T> bool foo(T) { return false; };
+    bool x = [[foo]](42);
+  )cpp";
+  EXPECT_DECLS("DeclRefExpr",
+               {"template<> bool foo<int>(int)", Rel::TemplateInstantiation},
+               {"bool foo(T)", Rel::TemplatePattern});
+
+  Code = R"cpp(
+    // Explicit specialization.
+    template<typename T> bool foo(T) { return false; };
+    template<> bool foo<int>(int) { return false; };
+    bool x = [[foo]](42);
+  )cpp";
+  EXPECT_DECLS("DeclRefExpr", "template<> bool foo<int>(int)");
+}
+
+TEST_F(TargetDeclTest, VariableTemplate) {
+  // Pretty-printer doesn't do a very good job of variable templates :-(
+  Code = R"cpp(
+    // Implicit specialization.
+    template<typename T> int foo;
+    int x = [[foo]]<char>;
+  )cpp";
+  EXPECT_DECLS("DeclRefExpr", {"int foo", Rel::TemplateInstantiation},
+               {"int foo", Rel::TemplatePattern});
+
+  Code = R"cpp(
+    // Explicit specialization.
+    template<typename T> int foo;
+    template <> bool foo<char>;
+    int x = [[foo]]<char>;
+  )cpp";
+  EXPECT_DECLS("DeclRefExpr", "bool foo");
+
+  Code = R"cpp(
+    // Partial specialization.
+    template<typename T> int foo;
+    template<typename T> bool foo<T*>;
+    bool x = [[foo]]<char*>;
+  )cpp";
+  EXPECT_DECLS("DeclRefExpr", {"bool foo", Rel::TemplateInstantiation},
+               {"bool foo", Rel::TemplatePattern});
+}
+
+TEST_F(TargetDeclTest, TypeAliasTemplate) {
+  Code = R"cpp(
+    template<typename T, int X> class SmallVector {};
+    template<typename U> using TinyVector = SmallVector<U, 1>;
+    [[TinyVector<int>]] X;
+  )cpp";
+  EXPECT_DECLS("TemplateSpecializationTypeLoc",
+               {"template<> class SmallVector<int, 1>",
+                Rel::TemplateInstantiation | Rel::Underlying},
+               {"class SmallVector", Rel::TemplatePattern | Rel::Underlying},
+               {"using TinyVector = SmallVector<U, 1>",
+                Rel::Alias | Rel::TemplatePattern});
+}
+
+TEST_F(TargetDeclTest, MemberOfTemplate) {
+  Code = R"cpp(
+    template <typename T> struct Foo {
+      int x(T);
+    };
+    int y = Foo<int>().[[x]](42);
+  )cpp";
+  EXPECT_DECLS("MemberExpr", {"int x(int)", Rel::TemplateInstantiation},
+               {"int x(T)", Rel::TemplatePattern});
+
+  Code = R"cpp(
+    template <typename T> struct Foo {
+      template <typename U>
+      int x(T, U);
+    };
+    int y = Foo<char>().[[x]]('c', 42);
+  )cpp";
+  EXPECT_DECLS("MemberExpr",
+               {"template<> int x<int>(char, int)", Rel::TemplateInstantiation},
+               {"int x(T, U)", Rel::TemplatePattern});
+}
+
+TEST_F(TargetDeclTest, Lambda) {
+  Code = R"cpp(
+    void foo(int x = 42) {
+      auto l = [ [[x]] ]{ return x + 1; };
+    };
+  )cpp";
+  EXPECT_DECLS("DeclRefExpr", "int x = 42");
+
+  // It seems like this should refer to another var, with the outer param being
+  // an underlying decl. But it doesn't seem to exist.
+  Code = R"cpp(
+    void foo(int x = 42) {
+      auto l = [x]{ return [[x]] + 1; };
+    };
+  )cpp";
+  EXPECT_DECLS("DeclRefExpr", "int x = 42");
+
+  Code = R"cpp(
+    void foo() {
+      auto l = [x = 1]{ return [[x]] + 1; };
+    };
+  )cpp";
+  // FIXME: why both auto and int?
+  EXPECT_DECLS("DeclRefExpr", "auto int x = 1");
+}
+
+TEST_F(TargetDeclTest, ObjC) {
+  Flags = {"-xobjective-c"};
+  Code = R"cpp(
+    @interface Foo {}
+    -(void)bar;
+    @end
+    void test(Foo *f) {
+      [f [[bar]] ];
+    }
+  )cpp";
+  EXPECT_DECLS("ObjCMessageExpr", "- (void)bar");
+
+  Code = R"cpp(
+    @interface Foo { @public int bar; }
+    @end
+    int test(Foo *f) {
+      return [[f->bar]];
+    }
+  )cpp";
+  EXPECT_DECLS("ObjCIvarRefExpr", "int bar");
+
+  Code = R"cpp(
+    @interface Foo {}
+    -(int) x;
+    -(void) setX:(int)x;
+    @end
+    void test(Foo *f) {
+      [[f.x]] = 42;
+    }
+  )cpp";
+  EXPECT_DECLS("ObjCPropertyRefExpr", "- (void)setX:(int)x");
+
+  Code = R"cpp(
+    @interface Foo {}
+    @property int x;
+    @end
+    void test(Foo *f) {
+      [[f.x]] = 42;
+    }
+  )cpp";
+  EXPECT_DECLS("ObjCPropertyRefExpr",
+               "@property(atomic, assign, unsafe_unretained, readwrite) int x");
+
+  Code = R"cpp(
+    @protocol Foo
+    @end
+    id test() {
+      return [[@protocol(Foo)]];
+    }
+  )cpp";
+  EXPECT_DECLS("ObjCProtocolExpr", "@protocol Foo");
+
+  Code = R"cpp(
+    @interface Foo
+    @end
+    void test([[Foo]] *p);
+  )cpp";
+  EXPECT_DECLS("ObjCInterfaceTypeLoc", "@interface Foo");
+
+  Code = R"cpp(
+    @protocol Foo
+    @end
+    void test([[id<Foo>]] p);
+  )cpp";
+  EXPECT_DECLS("ObjCObjectTypeLoc", "@protocol Foo");
+
+  Code = R"cpp(
+    @class C;
+    @protocol Foo
+    @end
+    void test(C<[[Foo]]> *p);
+  )cpp";
+  // FIXME: there's no AST node corresponding to 'Foo', so we're stuck.
+  EXPECT_DECLS("ObjCObjectTypeLoc");
+}
+
+} // namespace
+} // namespace clangd
+} // namespace clang