mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
e29ffdea5c
SourceEntityWalker is generally ignoring implicit AST nodes but we missed ignoring implicit patterns. This had the effect of not ignoring implicit pattern matches to Optional.some() which resulted in cursor-info returning Optional.some instead of what is actually written in code.
549 lines
16 KiB
C++
549 lines
16 KiB
C++
//===--- SourceEntityWalker.cpp - Routines for semantic source info -------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "swift/AST/SourceEntityWalker.h"
|
|
#include "swift/Parse/Lexer.h"
|
|
#include "swift/AST/ASTContext.h"
|
|
#include "swift/AST/ASTWalker.h"
|
|
#include "swift/AST/Decl.h"
|
|
#include "swift/AST/Expr.h"
|
|
#include "swift/AST/Module.h"
|
|
#include "swift/AST/Pattern.h"
|
|
#include "swift/AST/Stmt.h"
|
|
#include "swift/AST/TypeRepr.h"
|
|
#include "swift/AST/Types.h"
|
|
#include "swift/Basic/SourceManager.h"
|
|
#include "clang/Basic/Module.h"
|
|
|
|
using namespace swift;
|
|
|
|
namespace {
|
|
|
|
class SemaAnnotator : public ASTWalker {
|
|
SourceEntityWalker &SEWalker;
|
|
SmallVector<ConstructorRefCallExpr *, 2> CtorRefs;
|
|
SmallVector<ExtensionDecl *, 2> ExtDecls;
|
|
bool Cancelled = false;
|
|
|
|
public:
|
|
explicit SemaAnnotator(SourceEntityWalker &SEWalker)
|
|
: SEWalker(SEWalker) { }
|
|
|
|
bool isDone() const { return Cancelled; }
|
|
|
|
private:
|
|
bool shouldWalkIntoGenericParams() override {
|
|
return SEWalker.shouldWalkIntoGenericParams();
|
|
}
|
|
bool walkToDeclPre(Decl *D) override;
|
|
std::pair<bool, Expr *> walkToExprPre(Expr *E) override;
|
|
bool walkToTypeReprPre(TypeRepr *T) override;
|
|
|
|
bool walkToDeclPost(Decl *D) override;
|
|
Expr *walkToExprPost(Expr *E) override;
|
|
bool walkToTypeReprPost(TypeRepr *T) override;
|
|
|
|
std::pair<bool, Stmt *> walkToStmtPre(Stmt *S) override;
|
|
Stmt *walkToStmtPost(Stmt *S) override;
|
|
|
|
std::pair<bool, Pattern *> walkToPatternPre(Pattern *P) override;
|
|
|
|
bool handleImports(ImportDecl *Import);
|
|
bool passModulePathElements(ArrayRef<ImportDecl::AccessPathElement> Path,
|
|
const clang::Module *ClangMod);
|
|
|
|
bool passReference(ValueDecl *D, Type Ty, DeclNameLoc Loc, SemaReferenceKind Kind);
|
|
bool passReference(ModuleEntity Mod, std::pair<Identifier, SourceLoc> IdLoc);
|
|
|
|
bool passSubscriptReference(ValueDecl *D, SourceLoc Loc, bool IsOpenBracket);
|
|
|
|
bool passCallArgNames(Expr *Fn, TupleExpr *TupleE);
|
|
|
|
bool shouldIgnore(Decl *D, bool &ShouldVisitChildren);
|
|
|
|
ValueDecl *extractDecl(Expr *Fn) const {
|
|
if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Fn))
|
|
return DRE->getDecl();
|
|
if (auto ApplyE = dyn_cast<ApplyExpr>(Fn))
|
|
return extractDecl(ApplyE->getFn());
|
|
return nullptr;
|
|
}
|
|
};
|
|
|
|
} // end anonymous namespace
|
|
|
|
bool SemaAnnotator::walkToDeclPre(Decl *D) {
|
|
if (isDone())
|
|
return false;
|
|
|
|
bool ShouldVisitChildren;
|
|
if (shouldIgnore(D, ShouldVisitChildren))
|
|
return ShouldVisitChildren;
|
|
|
|
SourceLoc Loc = D->getLoc();
|
|
unsigned NameLen = 0;
|
|
|
|
if (ValueDecl *VD = dyn_cast<ValueDecl>(D)) {
|
|
if (VD->hasName())
|
|
NameLen = VD->getName().getLength();
|
|
|
|
} else if (ExtensionDecl *ED = dyn_cast<ExtensionDecl>(D)) {
|
|
SourceRange SR = ED->getExtendedTypeLoc().getSourceRange();
|
|
Loc = SR.Start;
|
|
if (Loc.isValid())
|
|
NameLen = ED->getASTContext().SourceMgr.getByteDistance(SR.Start, SR.End);
|
|
ExtDecls.push_back(ED);
|
|
} else if (auto Import = dyn_cast<ImportDecl>(D)) {
|
|
if (!handleImports(Import))
|
|
return false;
|
|
|
|
} else if (auto OpD = dyn_cast<OperatorDecl>(D)) {
|
|
Loc = OpD->getLoc();
|
|
if (Loc.isValid())
|
|
NameLen = OpD->getName().getLength();
|
|
|
|
} else if (auto PrecD = dyn_cast<PrecedenceGroupDecl>(D)) {
|
|
Loc = PrecD->getLoc();
|
|
if (Loc.isValid())
|
|
NameLen = PrecD->getName().getLength();
|
|
|
|
} else {
|
|
return true;
|
|
}
|
|
|
|
CharSourceRange Range = (Loc.isValid()) ? CharSourceRange(Loc, NameLen)
|
|
: CharSourceRange();
|
|
return SEWalker.walkToDeclPre(D, Range);
|
|
}
|
|
|
|
bool SemaAnnotator::walkToDeclPost(Decl *D) {
|
|
if (isDone())
|
|
return false;
|
|
|
|
bool ShouldVisitChildren;
|
|
if (shouldIgnore(D, ShouldVisitChildren))
|
|
return true;
|
|
|
|
// FIXME: rdar://17671977 the initializer for a lazy property has already
|
|
// been moved into its implicit getter.
|
|
if (auto *PBD = dyn_cast<PatternBindingDecl>(D)) {
|
|
if (auto *VD = PBD->getSingleVar()) {
|
|
if (VD->getAttrs().hasAttribute<LazyAttr>()) {
|
|
if (auto *Get = VD->getGetter()) {
|
|
assert((Get->isImplicit() || Get->isInvalid())
|
|
&& "lazy var getter must be either implicitly computed or invalid");
|
|
|
|
// Note that an implicit getter may not have the body synthesized
|
|
// in case the owning PatternBindingDecl is invalid.
|
|
if (auto *Body = Get->getBody()) {
|
|
Body->walk(*this);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (isa<ExtensionDecl>(D)) {
|
|
assert(ExtDecls.back() == D);
|
|
ExtDecls.pop_back();
|
|
}
|
|
|
|
if (!isa<ValueDecl>(D) && !isa<ExtensionDecl>(D) && !isa<ImportDecl>(D))
|
|
return true;
|
|
|
|
bool Continue = SEWalker.walkToDeclPost(D);
|
|
if (!Continue)
|
|
Cancelled = true;
|
|
return Continue;
|
|
}
|
|
|
|
std::pair<bool, Stmt *> SemaAnnotator::walkToStmtPre(Stmt *S) {
|
|
bool TraverseChildren = SEWalker.walkToStmtPre(S);
|
|
if (TraverseChildren) {
|
|
if (SEWalker.shouldWalkInactiveConfigRegion()) {
|
|
if (auto *ICS = dyn_cast<IfConfigStmt>(S)) {
|
|
TraverseChildren = false;
|
|
for (auto Clause : ICS->getClauses()) {
|
|
for (auto Member : Clause.Elements) {
|
|
Member.walk(*this);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (auto *DeferS = dyn_cast<DeferStmt>(S)) {
|
|
if (auto *FD = DeferS->getTempDecl()) {
|
|
auto *RetS = FD->getBody()->walk(*this);
|
|
// Already walked children.
|
|
return { false, RetS };
|
|
}
|
|
}
|
|
}
|
|
return { TraverseChildren, S };
|
|
}
|
|
|
|
Stmt *SemaAnnotator::walkToStmtPost(Stmt *S) {
|
|
bool Continue = SEWalker.walkToStmtPost(S);
|
|
if (!Continue)
|
|
Cancelled = true;
|
|
return Continue ? S : nullptr;
|
|
}
|
|
|
|
static SemaReferenceKind getReferenceKind(Expr *Parent, Expr *E) {
|
|
if (auto SA = dyn_cast_or_null<SelfApplyExpr>(Parent)) {
|
|
if (SA->getFn() == E)
|
|
return SemaReferenceKind::DeclMemberRef;
|
|
}
|
|
return SemaReferenceKind::DeclRef;
|
|
}
|
|
|
|
std::pair<bool, Expr *> SemaAnnotator::walkToExprPre(Expr *E) {
|
|
if (isDone())
|
|
return { false, nullptr };
|
|
|
|
if (!SEWalker.walkToExprPre(E))
|
|
return { false, E };
|
|
|
|
if (ConstructorRefCallExpr *CtorRefE = dyn_cast<ConstructorRefCallExpr>(E))
|
|
CtorRefs.push_back(CtorRefE);
|
|
|
|
if (E->isImplicit())
|
|
return { true, E };
|
|
|
|
if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E)) {
|
|
if (auto *module = dyn_cast<ModuleDecl>(DRE->getDecl())) {
|
|
if (!passReference(ModuleEntity(module),
|
|
std::make_pair(module->getName(), E->getLoc())))
|
|
return { false, nullptr };
|
|
} else if (!passReference(DRE->getDecl(), DRE->getType(),
|
|
DRE->getNameLoc(),
|
|
getReferenceKind(Parent.getAsExpr(), E))) {
|
|
return { false, nullptr };
|
|
}
|
|
} else if (MemberRefExpr *MRE = dyn_cast<MemberRefExpr>(E)) {
|
|
// Visit in source order.
|
|
if (!MRE->getBase()->walk(*this))
|
|
return { false, nullptr };
|
|
if (!passReference(MRE->getMember().getDecl(), MRE->getType(),
|
|
MRE->getNameLoc(), SemaReferenceKind::DeclMemberRef))
|
|
return { false, nullptr };
|
|
|
|
// We already visited the children.
|
|
if (!walkToExprPost(E))
|
|
return { false, nullptr };
|
|
return { false, E };
|
|
|
|
} else if (auto OtherCtorE = dyn_cast<OtherConstructorDeclRefExpr>(E)) {
|
|
if (!passReference(OtherCtorE->getDecl(), OtherCtorE->getType(),
|
|
OtherCtorE->getConstructorLoc(),
|
|
SemaReferenceKind::DeclConstructorRef))
|
|
return { false, nullptr };
|
|
|
|
} else if (SubscriptExpr *SE = dyn_cast<SubscriptExpr>(E)) {
|
|
// Visit in source order.
|
|
if (!SE->getBase()->walk(*this))
|
|
return { false, nullptr };
|
|
|
|
ValueDecl *SubscrD = nullptr;
|
|
if (SE->hasDecl())
|
|
SubscrD = SE->getDecl().getDecl();
|
|
|
|
if (SubscrD) {
|
|
if (!passSubscriptReference(SubscrD, E->getLoc(), true))
|
|
return { false, nullptr };
|
|
}
|
|
|
|
if (!SE->getIndex()->walk(*this))
|
|
return { false, nullptr };
|
|
|
|
if (SubscrD) {
|
|
if (!passSubscriptReference(SubscrD, E->getEndLoc(), false))
|
|
return { false, nullptr };
|
|
}
|
|
|
|
// We already visited the children.
|
|
if (!walkToExprPost(E))
|
|
return { false, nullptr };
|
|
return { false, E };
|
|
|
|
} else if (BinaryExpr *BinE = dyn_cast<BinaryExpr>(E)) {
|
|
// Visit in source order.
|
|
if (!BinE->getArg()->getElement(0)->walk(*this))
|
|
return { false, nullptr };
|
|
if (!BinE->getFn()->walk(*this))
|
|
return { false, nullptr };
|
|
if (!BinE->getArg()->getElement(1)->walk(*this))
|
|
return { false, nullptr };
|
|
|
|
// We already visited the children.
|
|
if (!walkToExprPost(E))
|
|
return { false, nullptr };
|
|
return { false, E };
|
|
|
|
} else if (auto TupleE = dyn_cast<TupleExpr>(E)) {
|
|
if (auto CallE = dyn_cast_or_null<CallExpr>(Parent.getAsExpr())) {
|
|
if (!passCallArgNames(CallE->getFn(), TupleE))
|
|
return { false, nullptr };
|
|
}
|
|
}
|
|
|
|
return { true, E };
|
|
}
|
|
|
|
bool SemaAnnotator::walkToTypeReprPre(TypeRepr *T) {
|
|
if (isDone())
|
|
return false;
|
|
|
|
if (auto IdT = dyn_cast<ComponentIdentTypeRepr>(T)) {
|
|
if (ValueDecl *VD = IdT->getBoundDecl()) {
|
|
if (ModuleDecl *ModD = dyn_cast<ModuleDecl>(VD))
|
|
return passReference(ModD, std::make_pair(IdT->getIdentifier(),
|
|
IdT->getIdLoc()));
|
|
|
|
return passReference(VD, Type(), DeclNameLoc(IdT->getIdLoc()),
|
|
SemaReferenceKind::TypeRef);
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
Expr *SemaAnnotator::walkToExprPost(Expr *E) {
|
|
if (isa<ConstructorRefCallExpr>(E)) {
|
|
assert(CtorRefs.back() == E);
|
|
CtorRefs.pop_back();
|
|
}
|
|
|
|
bool Continue = SEWalker.walkToExprPost(E);
|
|
if (!Continue)
|
|
Cancelled = true;
|
|
return Continue ? E : nullptr;
|
|
}
|
|
|
|
bool SemaAnnotator::walkToTypeReprPost(TypeRepr *T) {
|
|
if (isDone())
|
|
return false;
|
|
return true;
|
|
}
|
|
|
|
std::pair<bool, Pattern *> SemaAnnotator::walkToPatternPre(Pattern *P) {
|
|
if (P->isImplicit())
|
|
return { true, P };
|
|
|
|
if (auto *EP = dyn_cast<EnumElementPattern>(P)) {
|
|
auto *Element = EP->getElementDecl();
|
|
if (!Element)
|
|
return { true, P };
|
|
Type T = EP->hasType() ? EP->getType() : Type();
|
|
return { passReference(Element, T, DeclNameLoc(EP->getLoc()),
|
|
SemaReferenceKind::EnumElementRef), P };
|
|
}
|
|
|
|
auto *TP = dyn_cast<TypedPattern>(P);
|
|
if (!TP || !TP->isPropagatedType())
|
|
return { true, P };
|
|
|
|
// If the typed pattern was propagated from somewhere, just walk the
|
|
// subpattern. The type will be walked as a part of another TypedPattern.
|
|
TP->getSubPattern()->walk(*this);
|
|
return { false, P };
|
|
}
|
|
|
|
bool SemaAnnotator::handleImports(ImportDecl *Import) {
|
|
auto Mod = Import->getModule();
|
|
if (!Mod)
|
|
return true;
|
|
|
|
auto ClangMod = Mod->findUnderlyingClangModule();
|
|
if (ClangMod && ClangMod->isSubModule()) {
|
|
if (!passModulePathElements(Import->getModulePath(), ClangMod))
|
|
return false;
|
|
} else {
|
|
if (!passReference(Mod, Import->getModulePath().front()))
|
|
return false;
|
|
}
|
|
|
|
auto Decls = Import->getDecls();
|
|
if (Decls.size() == 1) {
|
|
// FIXME: ImportDecl should store a DeclNameLoc.
|
|
// FIXME: Handle overloaded funcs too by passing a reference for each?
|
|
if (!passReference(Decls.front(), Type(), DeclNameLoc(Import->getEndLoc()),
|
|
SemaReferenceKind::DeclRef))
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool SemaAnnotator::passModulePathElements(
|
|
ArrayRef<ImportDecl::AccessPathElement> Path,
|
|
const clang::Module *ClangMod) {
|
|
|
|
if (Path.empty() || !ClangMod)
|
|
return true;
|
|
|
|
if (!passModulePathElements(Path.drop_back(1), ClangMod->Parent))
|
|
return false;
|
|
|
|
return passReference(ClangMod, Path.back());
|
|
}
|
|
|
|
bool SemaAnnotator::passSubscriptReference(ValueDecl *D, SourceLoc Loc,
|
|
bool IsOpenBracket) {
|
|
CharSourceRange Range = Loc.isValid()
|
|
? CharSourceRange(Loc, 1)
|
|
: CharSourceRange();
|
|
|
|
bool Continue = SEWalker.visitSubscriptReference(D, Range, IsOpenBracket);
|
|
if (!Continue)
|
|
Cancelled = true;
|
|
return Continue;
|
|
}
|
|
|
|
bool SemaAnnotator::
|
|
passReference(ValueDecl *D, Type Ty, DeclNameLoc Loc, SemaReferenceKind Kind) {
|
|
TypeDecl *CtorTyRef = nullptr;
|
|
ExtensionDecl *ExtDecl = nullptr;
|
|
|
|
if (TypeDecl *TD = dyn_cast<TypeDecl>(D)) {
|
|
if (!CtorRefs.empty() && Loc.isValid()) {
|
|
Expr *Fn = CtorRefs.back()->getFn();
|
|
if (Fn->getLoc() == Loc.getBaseNameLoc()) {
|
|
D = extractDecl(Fn);
|
|
CtorTyRef = TD;
|
|
}
|
|
}
|
|
|
|
if (!ExtDecls.empty() && Loc.isValid()) {
|
|
auto ExtTyLoc = ExtDecls.back()->getExtendedTypeLoc().getLoc();
|
|
if (ExtTyLoc.isValid() && ExtTyLoc == Loc.getBaseNameLoc()) {
|
|
ExtDecl = ExtDecls.back();
|
|
}
|
|
}
|
|
}
|
|
|
|
CharSourceRange Range =
|
|
Lexer::getCharSourceRangeFromSourceRange(D->getASTContext().SourceMgr,
|
|
Loc.getSourceRange());
|
|
bool Continue = SEWalker.visitDeclReference(D, Range, CtorTyRef, ExtDecl, Ty,
|
|
Kind);
|
|
if (!Continue)
|
|
Cancelled = true;
|
|
return Continue;
|
|
}
|
|
|
|
bool SemaAnnotator::passReference(ModuleEntity Mod,
|
|
std::pair<Identifier, SourceLoc> IdLoc) {
|
|
if (IdLoc.second.isInvalid())
|
|
return true;
|
|
unsigned NameLen = IdLoc.first.getLength();
|
|
CharSourceRange Range{ IdLoc.second, NameLen };
|
|
bool Continue = SEWalker.visitModuleReference(Mod, Range);
|
|
if (!Continue)
|
|
Cancelled = true;
|
|
return Continue;
|
|
}
|
|
|
|
bool SemaAnnotator::passCallArgNames(Expr *Fn, TupleExpr *TupleE) {
|
|
ValueDecl *D = extractDecl(Fn);
|
|
if (!D)
|
|
return true; // continue.
|
|
|
|
ArrayRef<Identifier> ArgNames = TupleE->getElementNames();
|
|
ArrayRef<SourceLoc> ArgLocs = TupleE->getElementNameLocs();
|
|
for (auto i : indices(ArgNames)) {
|
|
Identifier Name = ArgNames[i];
|
|
if (Name.empty())
|
|
continue;
|
|
|
|
SourceLoc Loc = ArgLocs[i];
|
|
if (Loc.isInvalid())
|
|
continue;
|
|
|
|
CharSourceRange Range{ Loc, Name.getLength() };
|
|
bool Continue = SEWalker.visitCallArgName(Name, Range, D);
|
|
if (!Continue) {
|
|
Cancelled = true;
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool SemaAnnotator::shouldIgnore(Decl *D, bool &ShouldVisitChildren) {
|
|
if (D->isImplicit() && !isa<PatternBindingDecl>(D)) {
|
|
ShouldVisitChildren = false;
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
bool SourceEntityWalker::walk(SourceFile &SrcFile) {
|
|
SemaAnnotator Annotator(*this);
|
|
return SrcFile.walk(Annotator);
|
|
}
|
|
|
|
bool SourceEntityWalker::walk(ModuleDecl &Mod) {
|
|
SemaAnnotator Annotator(*this);
|
|
return Mod.walk(Annotator);
|
|
}
|
|
|
|
bool SourceEntityWalker::walk(Stmt *S) {
|
|
SemaAnnotator Annotator(*this);
|
|
return S->walk(Annotator);
|
|
}
|
|
|
|
bool SourceEntityWalker::walk(Expr *E) {
|
|
SemaAnnotator Annotator(*this);
|
|
return E->walk(Annotator);
|
|
}
|
|
|
|
bool SourceEntityWalker::walk(Decl *D) {
|
|
SemaAnnotator Annotator(*this);
|
|
return D->walk(Annotator);
|
|
}
|
|
|
|
bool SourceEntityWalker::walk(DeclContext *DC) {
|
|
SemaAnnotator Annotator(*this);
|
|
return DC->walkContext(Annotator);
|
|
}
|
|
|
|
bool SourceEntityWalker::visitDeclReference(ValueDecl *D, CharSourceRange Range,
|
|
TypeDecl *CtorTyRef,
|
|
ExtensionDecl *ExtTyRef, Type T,
|
|
SemaReferenceKind Kind) {
|
|
return true;
|
|
}
|
|
|
|
bool SourceEntityWalker::visitSubscriptReference(ValueDecl *D,
|
|
CharSourceRange Range,
|
|
bool IsOpenBracket) {
|
|
// Most of the clients treat subscript reference the same way as a
|
|
// regular reference when called on the open bracket and
|
|
// ignore the closing one.
|
|
return IsOpenBracket ? visitDeclReference(D, Range, nullptr, nullptr, Type(),
|
|
SemaReferenceKind::SubscriptRef) : true;
|
|
}
|
|
|
|
bool SourceEntityWalker::visitCallArgName(Identifier Name,
|
|
CharSourceRange Range,
|
|
ValueDecl *D) {
|
|
return true;
|
|
}
|
|
|
|
bool SourceEntityWalker::visitModuleReference(ModuleEntity Mod,
|
|
CharSourceRange Range) {
|
|
return true;
|
|
}
|
|
|
|
void SourceEntityWalker::anchor() {}
|