Skip to content

ASTScope: Pre-compute the right source ranges instead of relying on widening #34205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 7, 2020
Merged

ASTScope: Pre-compute the right source ranges instead of relying on widening #34205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
824ecdd
ASTScope: Fix AttachedPropertyWrapperScope source range
slavapestov Oct 6, 2020
66873b9
ASTScope: Fix SubscriptDeclScope source range
slavapestov Oct 6, 2020
2e67c13
ASTScope: Rework ConditionalClauseScopes
slavapestov Oct 2, 2020
dac68ca
ASTScope: Fix TopLevelCodeScope source range
slavapestov Oct 2, 2020
b8cccb1
ASTScope: Fix SourceFileScope source range
slavapestov Oct 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 45 additions & 64 deletions include/swift/AST/ASTScope.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -966,19 +966,8 @@ class AttachedPropertyWrapperScope final : public ASTScopeImpl {
CustomAttr *attr;
VarDecl *decl;

/// Because we have to avoid request cycles, we approximate the test for an
/// AttachedPropertyWrapper with one based on source location. We might get
/// false positives, that that doesn't hurt anything. However, the result of
/// the conservative source range computation doesn't seem to be stable. So
/// keep the original here, and use it for source range queries.
const SourceRange sourceRangeWhenCreated;

AttachedPropertyWrapperScope(CustomAttr *attr, VarDecl *decl)
: attr(attr), decl(decl),
sourceRangeWhenCreated(attr->getTypeRepr()->getSourceRange()) {
ASTScopeAssert(sourceRangeWhenCreated.isValid(),
"VarDecls must have ranges to be looked-up");
}
: attr(attr), decl(decl) {}
virtual ~AttachedPropertyWrapperScope() {}

protected:
Expand Down Expand Up @@ -1093,63 +1082,49 @@ class PatternEntryInitializerScope final : public AbstractPatternEntryScope {
bool lookupLocalsOrMembers(DeclConsumer) const override;
};

/// The scope introduced by a conditional clause in an if/guard/while
/// statement.
/// Since there may be more than one "let foo = ..." in (e.g.) an "if",
/// we allocate a matrushka of these.
class ConditionalClauseScope final : public ASTScopeImpl {
/// The scope introduced by a conditional clause initializer in an
/// if/while/guard statement.
class ConditionalClauseInitializerScope final : public ASTScopeImpl {
public:
LabeledConditionalStmt *const stmt;
const unsigned index;
const SourceLoc endLoc; // cannot get it from the stmt

ConditionalClauseScope(LabeledConditionalStmt *stmt, unsigned index,
SourceLoc endLoc)
: stmt(stmt), index(index), endLoc(endLoc) {}

virtual ~ConditionalClauseScope() {}
Expr *const initializer;
const SourceRange bodyRange;

protected:
ASTScopeImpl *expandSpecifically(ScopeCreator &scopeCreator) override;

private:
AnnotatedInsertionPoint
expandAScopeThatCreatesANewInsertionPoint(ScopeCreator &);

public:
std::string getClassName() const override;

protected:
void printSpecifics(llvm::raw_ostream &out) const override;
ConditionalClauseInitializerScope(Expr *initializer)
: initializer(initializer) {}

public:
virtual ~ConditionalClauseInitializerScope() {}
SourceRange
getSourceRangeOfThisASTNode(bool omitAssertions = false) const override;
std::string getClassName() const override;

private:
ArrayRef<StmtConditionElement> getCond() const;
const StmtConditionElement &getStmtConditionElement() const;
void expandAScopeThatDoesNotCreateANewInsertionPoint(ScopeCreator &);

protected:
bool isLabeledStmtLookupTerminator() const override;
ASTScopeImpl *expandSpecifically(ScopeCreator &scopeCreator) override;
NullablePtr<const ASTScopeImpl> getLookupParent() const override;
};

/// If, while, & guard statements all start with a conditional clause, then some
/// later part of the statement, (then, body, or after the guard) circumvents
/// the normal lookup rule to pass the lookup scope into the deepest conditional
/// clause.
class ConditionalClausePatternUseScope final : public ASTScopeImpl {
Pattern *const pattern;
const SourceLoc startLoc;
StmtConditionElement sec;
SourceLoc endLoc;

public:
ConditionalClausePatternUseScope(Pattern *pattern, SourceLoc startLoc)
: pattern(pattern), startLoc(startLoc) {}
ConditionalClausePatternUseScope(StmtConditionElement sec, SourceLoc endLoc)
: sec(sec), endLoc(endLoc) {}

SourceRange
getSourceRangeOfThisASTNode(bool omitAssertions = false) const override;
std::string getClassName() const override;

private:
AnnotatedInsertionPoint
expandAScopeThatCreatesANewInsertionPoint(ScopeCreator &);

protected:
ASTScopeImpl *expandSpecifically(ScopeCreator &) override;
bool lookupLocalsOrMembers(DeclConsumer) const override;
Expand Down Expand Up @@ -1214,8 +1189,10 @@ class ClosureParametersScope final : public ASTScopeImpl {
class TopLevelCodeScope final : public ASTScopeImpl {
public:
TopLevelCodeDecl *const decl;
SourceLoc endLoc;

TopLevelCodeScope(TopLevelCodeDecl *e) : decl(e) {}
TopLevelCodeScope(TopLevelCodeDecl *e, SourceLoc endLoc)
: decl(e), endLoc(endLoc) {}
virtual ~TopLevelCodeScope() {}

protected:
Expand Down Expand Up @@ -1361,7 +1338,7 @@ class LabeledConditionalStmtScope : public AbstractStmtScope {
protected:
/// Return the lookupParent required to search these.
ASTScopeImpl *createNestedConditionalClauseScopes(ScopeCreator &,
const Stmt *afterConds);
SourceLoc);
};

class IfStmtScope final : public LabeledConditionalStmtScope {
Expand Down Expand Up @@ -1419,28 +1396,24 @@ class GuardStmtScope final : public LabeledConditionalStmtScope {
getSourceRangeOfThisASTNode(bool omitAssertions = false) const override;
};

/// A scope after a guard statement that follows lookups into the conditions
/// Also for:
/// The insertion point of the last statement of an active clause in an #if
/// must be the lookup parent
/// of any following scopes. But the active clause may not be the last clause.
/// In short, this is another case where the lookup parent cannot follow the same
/// nesting as the source order. IfConfigUseScope implements this twist. It
/// follows the IfConfig, wraps all subsequent scopes, and redirects the lookup.
class LookupParentDiversionScope final : public ASTScopeImpl {
/// A scope for the body of a guard statement. Lookups from the body must
/// skip the parent scopes for introducing pattern bindings, since they're
/// not visible in the guard body, only after the body ends.
class GuardStmtBodyScope final : public ASTScopeImpl {
public:
ASTScopeImpl *const lookupParent;
const SourceLoc startLoc;
const SourceLoc endLoc;
BraceStmt *const body;

LookupParentDiversionScope(ASTScopeImpl *lookupParent,
SourceLoc startLoc, SourceLoc endLoc)
: lookupParent(lookupParent), startLoc(startLoc), endLoc(endLoc) {}
GuardStmtBodyScope(ASTScopeImpl *lookupParent, BraceStmt *body)
: lookupParent(lookupParent), body(body) {}

SourceRange
getSourceRangeOfThisASTNode(bool omitAssertions = false) const override;
std::string getClassName() const override;

private:
void expandAScopeThatDoesNotCreateANewInsertionPoint(ScopeCreator &);

protected:
ASTScopeImpl *expandSpecifically(ScopeCreator &) override;
NullablePtr<const ASTScopeImpl> getLookupParent() const override {
Expand Down Expand Up @@ -1672,13 +1645,21 @@ class BraceStmtScope final : public AbstractStmtScope {
/// definition.
SmallVector<VarDecl *, 2> localVars;

/// The end location for bindings introduced in this scope. This can
/// extend past the actual end of the BraceStmt in top-level code,
/// where every TopLevelCodeDecl introduces a new scope through the
/// end of the buffer.
SourceLoc endLoc;

public:
BraceStmtScope(BraceStmt *e,
SmallVector<ValueDecl *, 2> localFuncsAndTypes,
SmallVector<VarDecl *, 2> localVars)
SmallVector<VarDecl *, 2> localVars,
SourceLoc endLoc)
: stmt(e),
localFuncsAndTypes(localFuncsAndTypes),
localVars(localVars) {}
localVars(localVars),
endLoc(endLoc) {}
virtual ~BraceStmtScope() {}

protected:
Expand Down
13 changes: 2 additions & 11 deletions lib/AST/ASTScope.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,8 @@ DEFINE_GET_CLASS_NAME(DefaultArgumentInitializerScope)
DEFINE_GET_CLASS_NAME(AttachedPropertyWrapperScope)
DEFINE_GET_CLASS_NAME(PatternEntryDeclScope)
DEFINE_GET_CLASS_NAME(PatternEntryInitializerScope)
DEFINE_GET_CLASS_NAME(ConditionalClauseScope)
DEFINE_GET_CLASS_NAME(ConditionalClausePatternUseScope)
DEFINE_GET_CLASS_NAME(ConditionalClauseInitializerScope)
DEFINE_GET_CLASS_NAME(CaptureListScope)
DEFINE_GET_CLASS_NAME(ClosureParametersScope)
DEFINE_GET_CLASS_NAME(TopLevelCodeScope)
Expand All @@ -149,7 +149,7 @@ DEFINE_GET_CLASS_NAME(EnumElementScope)
DEFINE_GET_CLASS_NAME(IfStmtScope)
DEFINE_GET_CLASS_NAME(WhileStmtScope)
DEFINE_GET_CLASS_NAME(GuardStmtScope)
DEFINE_GET_CLASS_NAME(LookupParentDiversionScope)
DEFINE_GET_CLASS_NAME(GuardStmtBodyScope)
DEFINE_GET_CLASS_NAME(RepeatWhileScope)
DEFINE_GET_CLASS_NAME(DoStmtScope)
DEFINE_GET_CLASS_NAME(DoCatchStmtScope)
Expand Down Expand Up @@ -199,15 +199,6 @@ void ASTScopeImpl::postOrderDo(function_ref<void(ASTScopeImpl *)> fn) {
fn(this);
}

ArrayRef<StmtConditionElement> ConditionalClauseScope::getCond() const {
return stmt->getCond();
}

const StmtConditionElement &
ConditionalClauseScope::getStmtConditionElement() const {
return getCond()[index];
}

unsigned ASTScopeImpl::countDescendants() const {
unsigned count = 0;
const_cast<ASTScopeImpl *>(this)->preOrderDo(
Expand Down
Loading