[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
//===--- 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"
|
2019-09-25 20:40:22 +08:00
|
|
|
#include "clang/AST/Decl.h"
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
#include "clang/AST/DeclCXX.h"
|
|
|
|
#include "clang/AST/DeclTemplate.h"
|
|
|
|
#include "clang/AST/DeclVisitor.h"
|
|
|
|
#include "clang/AST/DeclarationName.h"
|
2019-09-25 20:40:22 +08:00
|
|
|
#include "clang/AST/Expr.h"
|
2019-09-27 17:39:10 +08:00
|
|
|
#include "clang/AST/ExprCXX.h"
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
#include "clang/AST/ExprObjC.h"
|
2019-09-25 20:40:22 +08:00
|
|
|
#include "clang/AST/NestedNameSpecifier.h"
|
|
|
|
#include "clang/AST/PrettyPrinter.h"
|
|
|
|
#include "clang/AST/RecursiveASTVisitor.h"
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
#include "clang/AST/StmtVisitor.h"
|
2019-10-01 18:02:23 +08:00
|
|
|
#include "clang/AST/TemplateBase.h"
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
#include "clang/AST/Type.h"
|
2019-09-25 20:40:22 +08:00
|
|
|
#include "clang/AST/TypeLoc.h"
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
#include "clang/AST/TypeLocVisitor.h"
|
2019-09-25 20:40:22 +08:00
|
|
|
#include "clang/Basic/LangOptions.h"
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
#include "clang/Basic/SourceLocation.h"
|
2019-09-25 20:40:22 +08:00
|
|
|
#include "llvm/ADT/STLExtras.h"
|
|
|
|
#include "llvm/ADT/SmallVector.h"
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
#include "llvm/Support/Casting.h"
|
|
|
|
#include "llvm/Support/Compiler.h"
|
|
|
|
#include "llvm/Support/raw_ostream.h"
|
2019-09-25 20:40:22 +08:00
|
|
|
#include <utility>
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
|
|
|
|
namespace clang {
|
|
|
|
namespace clangd {
|
|
|
|
namespace {
|
2019-09-25 20:40:22 +08:00
|
|
|
using ast_type_traits::DynTypedNode;
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
|
2019-09-03 21:54:27 +08:00
|
|
|
LLVM_ATTRIBUTE_UNUSED std::string
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
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);
|
|
|
|
}
|
2019-10-01 15:27:55 +08:00
|
|
|
void VisitOverloadExpr(const OverloadExpr *OE) {
|
|
|
|
for (auto *D : OE->decls())
|
|
|
|
Outer.add(D, Flags);
|
|
|
|
}
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
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;
|
2019-09-25 20:40:22 +08:00
|
|
|
for (const auto &Entry : allTargetDecls(N)) {
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
if (!(Entry.second & ~Mask))
|
|
|
|
Result.push_back(Entry.first);
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
return Result;
|
|
|
|
}
|
|
|
|
|
2019-09-25 20:40:22 +08:00
|
|
|
namespace {
|
|
|
|
/// Find declarations explicitly referenced in the source code defined by \p N.
|
|
|
|
/// For templates, will prefer to return a template instantiation whenever
|
|
|
|
/// possible. However, can also return a template pattern if the specialization
|
|
|
|
/// cannot be picked, e.g. in dependent code or when there is no corresponding
|
|
|
|
/// Decl for a template instantitation, e.g. for templated using decls:
|
|
|
|
/// template <class T> using Ptr = T*;
|
|
|
|
/// Ptr<int> x;
|
|
|
|
/// ^~~ there is no Decl for 'Ptr<int>', so we return the template pattern.
|
|
|
|
llvm::SmallVector<const NamedDecl *, 1>
|
|
|
|
explicitReferenceTargets(DynTypedNode N, DeclRelationSet Mask = {}) {
|
|
|
|
assert(!(Mask & (DeclRelation::TemplatePattern |
|
|
|
|
DeclRelation::TemplateInstantiation)) &&
|
|
|
|
"explicitRefenceTargets handles templates on its own");
|
|
|
|
auto Decls = allTargetDecls(N);
|
|
|
|
|
|
|
|
// We prefer to return template instantiation, but fallback to template
|
|
|
|
// pattern if instantiation is not available.
|
|
|
|
Mask |= DeclRelation::TemplatePattern | DeclRelation::TemplateInstantiation;
|
|
|
|
|
|
|
|
llvm::SmallVector<const NamedDecl *, 1> TemplatePatterns;
|
|
|
|
llvm::SmallVector<const NamedDecl *, 1> Targets;
|
|
|
|
bool SeenTemplateInstantiations = false;
|
|
|
|
for (auto &D : Decls) {
|
|
|
|
if (D.second & ~Mask)
|
|
|
|
continue;
|
|
|
|
if (D.second & DeclRelation::TemplatePattern) {
|
|
|
|
TemplatePatterns.push_back(llvm::cast<NamedDecl>(D.first));
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
if (D.second & DeclRelation::TemplateInstantiation)
|
|
|
|
SeenTemplateInstantiations = true;
|
|
|
|
Targets.push_back(llvm::cast<NamedDecl>(D.first));
|
|
|
|
}
|
|
|
|
if (!SeenTemplateInstantiations)
|
|
|
|
Targets.insert(Targets.end(), TemplatePatterns.begin(),
|
|
|
|
TemplatePatterns.end());
|
|
|
|
return Targets;
|
|
|
|
}
|
|
|
|
|
2019-10-18 20:07:19 +08:00
|
|
|
llvm::SmallVector<ReferenceLoc, 2> refInDecl(const Decl *D) {
|
2019-09-25 20:40:22 +08:00
|
|
|
struct Visitor : ConstDeclVisitor<Visitor> {
|
2019-10-18 20:07:19 +08:00
|
|
|
llvm::SmallVector<ReferenceLoc, 2> Refs;
|
2019-09-25 20:40:22 +08:00
|
|
|
|
|
|
|
void VisitUsingDirectiveDecl(const UsingDirectiveDecl *D) {
|
2019-10-18 20:07:19 +08:00
|
|
|
// We want to keep it as non-declaration references, as the
|
|
|
|
// "using namespace" declaration doesn't have a name.
|
|
|
|
Refs.push_back(ReferenceLoc{D->getQualifierLoc(),
|
|
|
|
D->getIdentLocation(),
|
|
|
|
/*IsDecl=*/false,
|
|
|
|
{D->getNominatedNamespaceAsWritten()}});
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
void VisitUsingDecl(const UsingDecl *D) {
|
2019-10-18 20:07:19 +08:00
|
|
|
// "using ns::identifer;" is a non-declaration reference.
|
|
|
|
Refs.push_back(
|
|
|
|
ReferenceLoc{D->getQualifierLoc(), D->getLocation(), /*IsDecl=*/false,
|
|
|
|
explicitReferenceTargets(DynTypedNode::create(*D),
|
|
|
|
DeclRelation::Underlying)});
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
void VisitNamespaceAliasDecl(const NamespaceAliasDecl *D) {
|
2019-10-18 20:07:19 +08:00
|
|
|
// For namespace alias, "namespace Foo = Target;", we add two references.
|
|
|
|
// Add a declaration reference for Foo.
|
|
|
|
VisitNamedDecl(D);
|
|
|
|
// Add a non-declaration reference for Target.
|
|
|
|
Refs.push_back(ReferenceLoc{D->getQualifierLoc(),
|
|
|
|
D->getTargetNameLoc(),
|
|
|
|
/*IsDecl=*/false,
|
|
|
|
{D->getAliasedNamespace()}});
|
|
|
|
}
|
|
|
|
|
|
|
|
void VisitNamedDecl(const NamedDecl *ND) {
|
|
|
|
// FIXME: decide on how to surface destructors when we need them.
|
|
|
|
if (llvm::isa<CXXDestructorDecl>(ND))
|
|
|
|
return;
|
2019-10-28 21:41:06 +08:00
|
|
|
// Filter anonymous decls, name location will point outside the name token
|
|
|
|
// and the clients are not prepared to handle that.
|
|
|
|
if (ND->getDeclName().isIdentifier() &&
|
|
|
|
!ND->getDeclName().getAsIdentifierInfo())
|
|
|
|
return;
|
|
|
|
Refs.push_back(ReferenceLoc{getQualifierLoc(*ND),
|
|
|
|
ND->getLocation(),
|
|
|
|
/*IsDecl=*/true,
|
|
|
|
{ND}});
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
Visitor V;
|
|
|
|
V.Visit(D);
|
2019-10-18 20:07:19 +08:00
|
|
|
return V.Refs;
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
|
|
|
|
2019-10-18 20:07:19 +08:00
|
|
|
llvm::SmallVector<ReferenceLoc, 2> refInExpr(const Expr *E) {
|
2019-09-25 20:40:22 +08:00
|
|
|
struct Visitor : ConstStmtVisitor<Visitor> {
|
|
|
|
// FIXME: handle more complicated cases, e.g. ObjC, designated initializers.
|
2019-10-18 20:07:19 +08:00
|
|
|
llvm::SmallVector<ReferenceLoc, 2> Refs;
|
2019-09-25 20:40:22 +08:00
|
|
|
|
|
|
|
void VisitDeclRefExpr(const DeclRefExpr *E) {
|
2019-10-18 20:07:19 +08:00
|
|
|
Refs.push_back(ReferenceLoc{E->getQualifierLoc(),
|
|
|
|
E->getNameInfo().getLoc(),
|
|
|
|
/*IsDecl=*/false,
|
|
|
|
{E->getFoundDecl()}});
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
void VisitMemberExpr(const MemberExpr *E) {
|
2019-10-18 20:07:19 +08:00
|
|
|
Refs.push_back(ReferenceLoc{E->getQualifierLoc(),
|
|
|
|
E->getMemberNameInfo().getLoc(),
|
|
|
|
/*IsDecl=*/false,
|
|
|
|
{E->getFoundDecl()}});
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
2019-09-27 17:39:10 +08:00
|
|
|
|
|
|
|
void VisitOverloadExpr(const OverloadExpr *E) {
|
2019-10-18 20:07:19 +08:00
|
|
|
Refs.push_back(ReferenceLoc{E->getQualifierLoc(),
|
|
|
|
E->getNameInfo().getLoc(),
|
|
|
|
/*IsDecl=*/false,
|
|
|
|
llvm::SmallVector<const NamedDecl *, 1>(
|
|
|
|
E->decls().begin(), E->decls().end())});
|
2019-09-27 17:39:10 +08:00
|
|
|
}
|
2019-09-25 20:40:22 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
Visitor V;
|
|
|
|
V.Visit(E);
|
2019-10-18 20:07:19 +08:00
|
|
|
return V.Refs;
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
|
|
|
|
2019-10-18 20:07:19 +08:00
|
|
|
llvm::SmallVector<ReferenceLoc, 2> refInTypeLoc(TypeLoc L) {
|
2019-09-25 20:40:22 +08:00
|
|
|
struct Visitor : TypeLocVisitor<Visitor> {
|
|
|
|
llvm::Optional<ReferenceLoc> Ref;
|
|
|
|
|
|
|
|
void VisitElaboratedTypeLoc(ElaboratedTypeLoc L) {
|
|
|
|
// We only know about qualifier, rest if filled by inner locations.
|
|
|
|
Visit(L.getNamedTypeLoc().getUnqualifiedLoc());
|
|
|
|
// Fill in the qualifier.
|
|
|
|
if (!Ref)
|
|
|
|
return;
|
|
|
|
assert(!Ref->Qualifier.hasQualifier() && "qualifier already set");
|
|
|
|
Ref->Qualifier = L.getQualifierLoc();
|
|
|
|
}
|
|
|
|
|
|
|
|
void VisitTagTypeLoc(TagTypeLoc L) {
|
2019-10-18 20:07:19 +08:00
|
|
|
Ref = ReferenceLoc{NestedNameSpecifierLoc(),
|
|
|
|
L.getNameLoc(),
|
|
|
|
/*IsDecl=*/false,
|
|
|
|
{L.getDecl()}};
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
|
|
|
|
2019-09-27 18:55:53 +08:00
|
|
|
void VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc L) {
|
2019-10-18 20:07:19 +08:00
|
|
|
Ref = ReferenceLoc{NestedNameSpecifierLoc(),
|
|
|
|
L.getNameLoc(),
|
|
|
|
/*IsDecl=*/false,
|
|
|
|
{L.getDecl()}};
|
2019-09-27 18:55:53 +08:00
|
|
|
}
|
|
|
|
|
2019-09-25 20:40:22 +08:00
|
|
|
void VisitTemplateSpecializationTypeLoc(TemplateSpecializationTypeLoc L) {
|
2019-09-28 01:55:46 +08:00
|
|
|
// We must ensure template type aliases are included in results if they
|
|
|
|
// were written in the source code, e.g. in
|
|
|
|
// template <class T> using valias = vector<T>;
|
|
|
|
// ^valias<int> x;
|
|
|
|
// 'explicitReferenceTargets' will return:
|
|
|
|
// 1. valias with mask 'Alias'.
|
|
|
|
// 2. 'vector<int>' with mask 'Underlying'.
|
|
|
|
// we want to return only #1 in this case.
|
2019-09-25 20:40:22 +08:00
|
|
|
Ref = ReferenceLoc{
|
2019-10-18 20:07:19 +08:00
|
|
|
NestedNameSpecifierLoc(), L.getTemplateNameLoc(), /*IsDecl=*/false,
|
2019-09-28 01:55:46 +08:00
|
|
|
explicitReferenceTargets(DynTypedNode::create(L.getType()),
|
|
|
|
DeclRelation::Alias)};
|
|
|
|
}
|
|
|
|
void VisitDeducedTemplateSpecializationTypeLoc(
|
|
|
|
DeducedTemplateSpecializationTypeLoc L) {
|
|
|
|
Ref = ReferenceLoc{
|
2019-10-18 20:07:19 +08:00
|
|
|
NestedNameSpecifierLoc(), L.getNameLoc(), /*IsDecl=*/false,
|
2019-09-28 01:55:46 +08:00
|
|
|
explicitReferenceTargets(DynTypedNode::create(L.getType()),
|
|
|
|
DeclRelation::Alias)};
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
void VisitDependentTemplateSpecializationTypeLoc(
|
|
|
|
DependentTemplateSpecializationTypeLoc L) {
|
|
|
|
Ref = ReferenceLoc{
|
2019-10-18 20:07:19 +08:00
|
|
|
L.getQualifierLoc(), L.getTemplateNameLoc(), /*IsDecl=*/false,
|
2019-09-25 20:40:22 +08:00
|
|
|
explicitReferenceTargets(DynTypedNode::create(L.getType()))};
|
|
|
|
}
|
|
|
|
|
|
|
|
void VisitDependentNameTypeLoc(DependentNameTypeLoc L) {
|
|
|
|
Ref = ReferenceLoc{
|
2019-10-18 20:07:19 +08:00
|
|
|
L.getQualifierLoc(), L.getNameLoc(), /*IsDecl=*/false,
|
2019-09-25 20:40:22 +08:00
|
|
|
explicitReferenceTargets(DynTypedNode::create(L.getType()))};
|
|
|
|
}
|
|
|
|
|
|
|
|
void VisitTypedefTypeLoc(TypedefTypeLoc L) {
|
2019-10-18 20:07:19 +08:00
|
|
|
Ref = ReferenceLoc{NestedNameSpecifierLoc(),
|
|
|
|
L.getNameLoc(),
|
|
|
|
/*IsDecl=*/false,
|
|
|
|
{L.getTypedefNameDecl()}};
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
Visitor V;
|
|
|
|
V.Visit(L.getUnqualifiedLoc());
|
2019-10-18 20:07:19 +08:00
|
|
|
if (!V.Ref)
|
|
|
|
return {};
|
|
|
|
return {*V.Ref};
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
class ExplicitReferenceColletor
|
|
|
|
: public RecursiveASTVisitor<ExplicitReferenceColletor> {
|
|
|
|
public:
|
|
|
|
ExplicitReferenceColletor(llvm::function_ref<void(ReferenceLoc)> Out)
|
|
|
|
: Out(Out) {
|
|
|
|
assert(Out);
|
|
|
|
}
|
|
|
|
|
|
|
|
bool VisitTypeLoc(TypeLoc TTL) {
|
|
|
|
if (TypeLocsToSkip.count(TTL.getBeginLoc().getRawEncoding()))
|
|
|
|
return true;
|
|
|
|
visitNode(DynTypedNode::create(TTL));
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool TraverseElaboratedTypeLoc(ElaboratedTypeLoc L) {
|
|
|
|
// ElaboratedTypeLoc will reports information for its inner type loc.
|
|
|
|
// Otherwise we loose information about inner types loc's qualifier.
|
|
|
|
TypeLoc Inner = L.getNamedTypeLoc().getUnqualifiedLoc();
|
|
|
|
TypeLocsToSkip.insert(Inner.getBeginLoc().getRawEncoding());
|
|
|
|
return RecursiveASTVisitor::TraverseElaboratedTypeLoc(L);
|
|
|
|
}
|
|
|
|
|
|
|
|
bool VisitExpr(Expr *E) {
|
|
|
|
visitNode(DynTypedNode::create(*E));
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2019-10-01 18:02:23 +08:00
|
|
|
// We re-define Traverse*, since there's no corresponding Visit*.
|
|
|
|
// TemplateArgumentLoc is the only way to get locations for references to
|
|
|
|
// template template parameters.
|
|
|
|
bool TraverseTemplateArgumentLoc(TemplateArgumentLoc A) {
|
|
|
|
switch (A.getArgument().getKind()) {
|
|
|
|
case TemplateArgument::Template:
|
|
|
|
case TemplateArgument::TemplateExpansion:
|
|
|
|
reportReference(ReferenceLoc{A.getTemplateQualifierLoc(),
|
|
|
|
A.getTemplateNameLoc(),
|
2019-10-18 20:07:19 +08:00
|
|
|
/*IsDecl=*/false,
|
2019-10-01 18:02:23 +08:00
|
|
|
{A.getArgument()
|
|
|
|
.getAsTemplateOrTemplatePattern()
|
|
|
|
.getAsTemplateDecl()}},
|
|
|
|
DynTypedNode::create(A.getArgument()));
|
|
|
|
break;
|
|
|
|
case TemplateArgument::Declaration:
|
|
|
|
break; // FIXME: can this actually happen in TemplateArgumentLoc?
|
|
|
|
case TemplateArgument::Integral:
|
|
|
|
case TemplateArgument::Null:
|
|
|
|
case TemplateArgument::NullPtr:
|
|
|
|
break; // no references.
|
|
|
|
case TemplateArgument::Pack:
|
|
|
|
case TemplateArgument::Type:
|
|
|
|
case TemplateArgument::Expression:
|
|
|
|
break; // Handled by VisitType and VisitExpression.
|
|
|
|
};
|
|
|
|
return RecursiveASTVisitor::TraverseTemplateArgumentLoc(A);
|
|
|
|
}
|
|
|
|
|
2019-09-25 20:40:22 +08:00
|
|
|
bool VisitDecl(Decl *D) {
|
|
|
|
visitNode(DynTypedNode::create(*D));
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
// We have to use Traverse* because there is no corresponding Visit*.
|
|
|
|
bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc L) {
|
|
|
|
if (!L.getNestedNameSpecifier())
|
|
|
|
return true;
|
|
|
|
visitNode(DynTypedNode::create(L));
|
|
|
|
// Inner type is missing information about its qualifier, skip it.
|
|
|
|
if (auto TL = L.getTypeLoc())
|
|
|
|
TypeLocsToSkip.insert(TL.getBeginLoc().getRawEncoding());
|
|
|
|
return RecursiveASTVisitor::TraverseNestedNameSpecifierLoc(L);
|
|
|
|
}
|
|
|
|
|
2019-10-21 16:11:30 +08:00
|
|
|
bool TraverseConstructorInitializer(CXXCtorInitializer *Init) {
|
|
|
|
visitNode(DynTypedNode::create(*Init));
|
|
|
|
return RecursiveASTVisitor::TraverseConstructorInitializer(Init);
|
|
|
|
}
|
|
|
|
|
2019-09-25 20:40:22 +08:00
|
|
|
private:
|
|
|
|
/// Obtain information about a reference directly defined in \p N. Does not
|
|
|
|
/// recurse into child nodes, e.g. do not expect references for constructor
|
|
|
|
/// initializers
|
|
|
|
///
|
|
|
|
/// Any of the fields in the returned structure can be empty, but not all of
|
|
|
|
/// them, e.g.
|
|
|
|
/// - for implicitly generated nodes (e.g. MemberExpr from range-based-for),
|
|
|
|
/// source location information may be missing,
|
|
|
|
/// - for dependent code, targets may be empty.
|
|
|
|
///
|
|
|
|
/// (!) For the purposes of this function declarations are not considered to
|
|
|
|
/// be references. However, declarations can have references inside them,
|
|
|
|
/// e.g. 'namespace foo = std' references namespace 'std' and this
|
|
|
|
/// function will return the corresponding reference.
|
2019-10-18 20:07:19 +08:00
|
|
|
llvm::SmallVector<ReferenceLoc, 2> explicitReference(DynTypedNode N) {
|
2019-09-25 20:40:22 +08:00
|
|
|
if (auto *D = N.get<Decl>())
|
|
|
|
return refInDecl(D);
|
|
|
|
if (auto *E = N.get<Expr>())
|
|
|
|
return refInExpr(E);
|
2019-10-31 18:58:57 +08:00
|
|
|
if (auto *NNSL = N.get<NestedNameSpecifierLoc>()) {
|
|
|
|
// (!) 'DeclRelation::Alias' ensures we do not loose namespace aliases.
|
|
|
|
return {ReferenceLoc{
|
|
|
|
NNSL->getPrefix(), NNSL->getLocalBeginLoc(), false,
|
|
|
|
explicitReferenceTargets(
|
|
|
|
DynTypedNode::create(*NNSL->getNestedNameSpecifier()),
|
|
|
|
DeclRelation::Alias)}};
|
|
|
|
}
|
2019-09-25 20:40:22 +08:00
|
|
|
if (const TypeLoc *TL = N.get<TypeLoc>())
|
|
|
|
return refInTypeLoc(*TL);
|
|
|
|
if (const CXXCtorInitializer *CCI = N.get<CXXCtorInitializer>()) {
|
2019-10-21 16:11:30 +08:00
|
|
|
// Other type initializers (e.g. base initializer) are handled by visiting
|
|
|
|
// the typeLoc.
|
|
|
|
if (CCI->isAnyMemberInitializer()) {
|
|
|
|
return {ReferenceLoc{NestedNameSpecifierLoc(),
|
|
|
|
CCI->getMemberLocation(),
|
|
|
|
/*IsDecl=*/false,
|
|
|
|
{CCI->getAnyMember()}}};
|
|
|
|
}
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
|
|
|
// We do not have location information for other nodes (QualType, etc)
|
2019-10-18 20:07:19 +08:00
|
|
|
return {};
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
void visitNode(DynTypedNode N) {
|
2019-10-18 20:07:19 +08:00
|
|
|
for (const auto &R : explicitReference(N))
|
|
|
|
reportReference(R, N);
|
2019-10-01 18:02:23 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
void reportReference(const ReferenceLoc &Ref, DynTypedNode N) {
|
2019-09-25 20:40:22 +08:00
|
|
|
// Our promise is to return only references from the source code. If we lack
|
|
|
|
// location information, skip these nodes.
|
|
|
|
// Normally this should not happen in practice, unless there are bugs in the
|
|
|
|
// traversals or users started the traversal at an implicit node.
|
2019-10-01 18:02:23 +08:00
|
|
|
if (Ref.NameLoc.isInvalid()) {
|
2019-09-25 20:40:22 +08:00
|
|
|
dlog("invalid location at node {0}", nodeToString(N));
|
|
|
|
return;
|
|
|
|
}
|
2019-10-01 18:02:23 +08:00
|
|
|
Out(Ref);
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
llvm::function_ref<void(ReferenceLoc)> Out;
|
|
|
|
/// TypeLocs starting at these locations must be skipped, see
|
|
|
|
/// TraverseElaboratedTypeSpecifierLoc for details.
|
|
|
|
llvm::DenseSet</*SourceLocation*/ unsigned> TypeLocsToSkip;
|
|
|
|
};
|
|
|
|
} // namespace
|
|
|
|
|
2019-09-25 23:44:26 +08:00
|
|
|
void findExplicitReferences(const Stmt *S,
|
2019-09-25 20:40:22 +08:00
|
|
|
llvm::function_ref<void(ReferenceLoc)> Out) {
|
|
|
|
assert(S);
|
2019-09-25 23:44:26 +08:00
|
|
|
ExplicitReferenceColletor(Out).TraverseStmt(const_cast<Stmt *>(S));
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
2019-09-25 23:44:26 +08:00
|
|
|
void findExplicitReferences(const Decl *D,
|
2019-09-25 20:40:22 +08:00
|
|
|
llvm::function_ref<void(ReferenceLoc)> Out) {
|
|
|
|
assert(D);
|
2019-09-25 23:44:26 +08:00
|
|
|
ExplicitReferenceColletor(Out).TraverseDecl(const_cast<Decl *>(D));
|
2019-09-25 20:40:22 +08:00
|
|
|
}
|
[clangd] Implement semantic highlightings via findExplicitReferences
Summary:
To keep the logic of finding locations of interesting AST nodes in one
place.
The advantage is better coverage of various AST nodes, both now and in
the future: as new nodes get added to `findExplicitReferences`, semantic
highlighting will automatically pick them up.
The drawback of this change is that we have to traverse declarations
inside our file twice in order to highlight dependent names, 'auto'
and 'decltype'. Hopefully, this should not affect the actual latency
too much, most time should be spent in building the AST and not
traversing it.
Reviewers: hokein
Reviewed By: hokein
Subscribers: nridge, merge_guards_bot, MaskRay, jkorous, arphaman, kadircet, usaxena95, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D69673
2019-11-06 02:06:12 +08:00
|
|
|
void findExplicitReferences(const ASTContext &AST,
|
|
|
|
llvm::function_ref<void(ReferenceLoc)> Out) {
|
|
|
|
ExplicitReferenceColletor(Out).TraverseAST(const_cast<ASTContext &>(AST));
|
|
|
|
}
|
2019-09-25 20:40:22 +08:00
|
|
|
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
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
|
2019-09-03 23:02:46 +08:00
|
|
|
}
|
2019-09-03 21:05:13 +08:00
|
|
|
llvm_unreachable("Unhandled DeclRelation enum");
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
}
|
|
|
|
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;
|
|
|
|
}
|
|
|
|
|
2019-09-25 20:40:22 +08:00
|
|
|
llvm::raw_ostream &operator<<(llvm::raw_ostream &OS, ReferenceLoc R) {
|
|
|
|
// note we cannot print R.NameLoc without a source manager.
|
|
|
|
OS << "targets = {";
|
|
|
|
bool First = true;
|
|
|
|
for (const NamedDecl *T : R.Targets) {
|
|
|
|
if (!First)
|
|
|
|
OS << ", ";
|
|
|
|
else
|
|
|
|
First = false;
|
|
|
|
OS << printQualifiedName(*T) << printTemplateSpecializationArgs(*T);
|
|
|
|
}
|
|
|
|
OS << "}";
|
|
|
|
if (R.Qualifier) {
|
|
|
|
OS << ", qualifier = '";
|
|
|
|
R.Qualifier.getNestedNameSpecifier()->print(OS,
|
|
|
|
PrintingPolicy(LangOptions()));
|
|
|
|
OS << "'";
|
|
|
|
}
|
2019-10-18 20:07:19 +08:00
|
|
|
if (R.IsDecl)
|
|
|
|
OS << ", decl";
|
2019-09-25 20:40:22 +08:00
|
|
|
return OS;
|
|
|
|
}
|
|
|
|
|
[clangd] Add targetDecl(), which determines what declaration an AST node refers to.
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.
Reviewers: kadircet, ilya-biryukov
Subscribers: mgorny, MaskRay, jkorous, arphaman, jfb, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D66751
llvm-svn: 370746
2019-09-03 19:35:50 +08:00
|
|
|
} // namespace clangd
|
|
|
|
} // namespace clang
|