Skip to content

Commit 4e0bdad

Browse files
allevatoallevato
authored
Merge pull request #77177 from dylansturg/shadow_locals
Emit references to shadowed variables in if-let shorthands
2 parents 5c7509b + ce55a85 commit 4e0bdad

File tree

5 files changed

+49
-26
lines changed

5 files changed

+49
-26
lines changed

‎include/swift/Index/IndexSymbol.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ struct IndexSymbol : IndexRelation {
6565
SmallVector<IndexRelation, 3> Relations;
6666
unsigned line = 0;
6767
unsigned column = 0;
68+
const Decl *originalDecl = nullptr;
6869

6970
IndexSymbol() = default;
7071

‎lib/Index/Index.cpp‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -850,13 +850,13 @@ class IndexSwiftASTWalker : public SourceEntityWalker {
850850
if (Loc.isInvalid() || isSuppressed(Loc))
851851
return true;
852852

853+
IndexSymbol Info;
854+
853855
// Dig back to the original captured variable
854856
if (auto *VD = dyn_cast<VarDecl>(D)) {
855-
D = firstDecl(D);
857+
Info.originalDecl = firstDecl(D);
856858
}
857859

858-
IndexSymbol Info;
859-
860860
if (Data.isImplicit)
861861
Info.roles |= (unsigned)SymbolRole::Implicit;
862862

@@ -1580,13 +1580,17 @@ bool IndexSwiftASTWalker::report(ValueDecl *D) {
15801580
if (!reportRef(shadowedDecl, loc, info, AccessKind::Read))
15811581
return false;
15821582

1583-
// Suppress the reference if there is any (it is implicit and hence
1584-
// already skipped in the shorthand if let case, but explicit in the
1585-
// captured case).
1586-
suppressRefAtLoc(loc);
1583+
// Keep the refs and definition for the real decl when indexing locals,
1584+
// so the references to the shadowing variable are distinct.
1585+
if (!IdxConsumer.indexLocals()) {
1586+
// Suppress the reference if there is any (it is implicit and hence
1587+
// already skipped in the shorthand if let case, but explicit in the
1588+
// captured case).
1589+
suppressRefAtLoc(loc);
15871590

1588-
// Skip the definition of a shadowed decl
1589-
return true;
1591+
// Skip the definition of a shadowed decl
1592+
return true;
1593+
}
15901594
}
15911595

15921596
if (startEntityDecl(D)) {

‎lib/Refactoring/LocalRename.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ class RenameRangeCollector : public IndexDataConsumer {
221221
bool finishDependency(bool isClangModule) override { return true; }
222222

223223
Action startSourceEntity(const IndexSymbol &symbol) override {
224-
if (symbol.decl != declToRename) {
224+
if (symbol.decl != declToRename && symbol.originalDecl != declToRename) {
225225
return IndexDataConsumer::Continue;
226226
}
227227
auto loc = indexSymbolToRenameLoc(symbol);

‎test.o‎

5.83 KB
Binary file not shown.

‎test/Index/index_shadow.swift‎

Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
// RUN: %empty-directory(%t)
2-
// RUN: %target-swift-ide-test -print-indexed-symbols -source-filename %s --include-locals | %FileCheck %s
2+
// RUN: %target-swift-ide-test -print-indexed-symbols -source-filename %s | %FileCheck %s
3+
4+
// RUN: %empty-directory(%t)
5+
// RUN: %target-swift-ide-test -print-indexed-symbols -source-filename %s -include-locals | %FileCheck %s -check-prefix=CHECK_LOCALS
36

47
// The index will output references to the shadowed-declaration rather than
58
// the one defined by the shorthand if-let or capture. It also skips
@@ -9,61 +12,76 @@ struct ShadowedTest {
912
let shadowedVar: Int?? = 1
1013

1114
func localShadowTest() {
12-
// CHECK: [[@LINE+1]]:9 {{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL_SiSgvp {{.*}}Def
15+
// CHECK_LOCALS: [[@LINE+1]]:9 {{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL_SiSgvp {{.*}}Def
1316
let localShadowedVar: Int? = 2
1417

15-
// CHECK-NOT: [[@LINE+2]]:12 {{.*}} localShadowedVar {{.*}}Def
16-
// CHECK: [[@LINE+1]]:12 {{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL_SiSgvp {{.*}}Ref
18+
// CHECK_LOCALS: [[@LINE+2]]:12 {{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL_SiSgvp {{.*}}Ref
19+
// CHECK_LOCALS: [[@LINE+1]]:12 | variable(local)/Swift{{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL0_Sivp {{.*}}Def
1720
if let localShadowedVar {
18-
// CHECK: [[@LINE+1]]:11 {{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL_SiSgvp {{.*}}Ref
21+
// CHECK_LOCALS-NOT: [[@LINE+2]]:11 {{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL_SiSgvp {{.*}}
22+
// CHECK_LOCALS: [[@LINE+1]]:11 {{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL0_Sivp {{.*}}Ref
1923
_ = localShadowedVar
2024
}
2125

22-
// CHECK-NOT: [[@LINE+2]]:12 {{.*}} localShadowedVar {{.*}}Def
23-
// CHECK: [[@LINE+1]]:12 {{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL_SiSgvp {{.*}}Ref
26+
// CHECK_LOCALS: [[@LINE+2]]:12 {{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL_SiSgvp {{.*}}Ref
27+
// CHECK_LOCALS: [[@LINE+1]]:12 | variable(local)/Swift {{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL1_SiSgvp {{.*}}Def
2428
_ = { [localShadowedVar] in
25-
// CHECK: [[@LINE+1]]:11 {{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL_SiSgvp {{.*}}Ref
29+
// CHECK_LOCALS-NOT: [[@LINE+2]]:11 {{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL_SiSgvp {{.*}}
30+
// CHECK_LOCALS: [[@LINE+1]]:11 {{.*}} s:14swift_ide_test12ShadowedTestV011localShadowE0yyF0fD3VarL1_SiSgvp {{.*}}Ref
2631
_ = localShadowedVar
2732
}
2833
}
2934

3035
func shadowTest() {
36+
// CHECK_LOCALS: [[@LINE+4]]:12 | variable(local)/Swift {{.*}} s:14swift_ide_test12ShadowedTestV06shadowE0yyF11shadowedVarL_SiSgvp {{.*}}Def
37+
// CHECK_LOCALS: [[@LINE+3]]:12 {{.*}} s:14swift_ide_test12ShadowedTestV11shadowedVarSiSgSgvp {{.*}}Ref
3138
// CHECK-NOT: [[@LINE+2]]:12 {{.*}} shadowedVar {{.*}}Def
3239
// CHECK: [[@LINE+1]]:12 {{.*}} s:14swift_ide_test12ShadowedTestV11shadowedVarSiSgSgvp {{.*}}Ref
3340
if let shadowedVar {
34-
// CHECK: [[@LINE+1]]:11 {{.*}} s:14swift_ide_test12ShadowedTestV11shadowedVarSiSgSgvp {{.*}}Ref
41+
// CHECK_LOCALS-NOT: [[@LINE+3]]:11 {{.*}} s:14swift_ide_test12ShadowedTestV11shadowedVarSiSgSgvp {{.*}}Ref
42+
// CHECK_LOCALS: [[@LINE+2]]:11 {{.*}} s:14swift_ide_test12ShadowedTestV06shadowE0yyF11shadowedVarL_SiSgvp {{.*}}Ref
43+
// CHECK-NOT: [[@LINE+1]]:11 {{.*}} shadowedVar {{.*}}Ref
3544
_ = shadowedVar
3645

46+
// CHECK_LOCALS: [[@LINE+4]]:14 {{.*}} s:14swift_ide_test12ShadowedTestV11shadowedVarSiSgSgvp {{.*}}Ref
47+
// CHECK_LOCALS: [[@LINE+3]]:14 | variable(local)/Swift {{.*}} s:14swift_ide_test12ShadowedTestV06shadowE0yyF11shadowedVarL0_Sivp {{.*}}Def
3748
// CHECK-NOT: [[@LINE+2]]:14 {{.*}} shadowedVar {{.*}}Def
3849
// CHECK: [[@LINE+1]]:14 {{.*}} s:14swift_ide_test12ShadowedTestV11shadowedVarSiSgSgvp {{.*}}Ref
3950
if let shadowedVar {
40-
// CHECK: [[@LINE+1]]:13 {{.*}} s:14swift_ide_test12ShadowedTestV11shadowedVarSiSgSgvp {{.*}}Ref
51+
// CHECK_LOCALS: [[@LINE+2]]:13 {{.*}} s:14swift_ide_test12ShadowedTestV06shadowE0yyF11shadowedVarL0_Sivp {{.*}}Ref
52+
// CHECK-NOT: [[@LINE+1]]:13 {{.*}} shadowedVar {{.*}}Ref
4153
_ = shadowedVar
4254
}
4355
}
4456

57+
// CHECK_LOCALS: [[@LINE+4]]:12 {{.*}} s:14swift_ide_test12ShadowedTestV11shadowedVarSiSgSgvp {{.*}}Ref
58+
// CHECK_LOCALS: [[@LINE+3]]:12 | variable(local)/Swift {{.*}} s:14swift_ide_test12ShadowedTestV06shadowE0yyF11shadowedVarL1_SiSgSgvp {{.*}}Def
4559
// CHECK-NOT: [[@LINE+2]]:12 {{.*}} shadowedVar {{.*}}Def
4660
// CHECK: [[@LINE+1]]:12 {{.*}} s:14swift_ide_test12ShadowedTestV11shadowedVarSiSgSgvp {{.*}}Ref
4761
_ = { [shadowedVar] in
48-
// CHECK: [[@LINE+1]]:11 {{.*}} s:14swift_ide_test12ShadowedTestV11shadowedVarSiSgSgvp {{.*}}Ref
62+
// CHECK_LOCALS: [[@LINE+2]]:11 {{.*}} s:14swift_ide_test12ShadowedTestV06shadowE0yyF11shadowedVarL1_SiSgSgvp {{.*}}Ref
63+
// CHECK-NOT: [[@LINE+1]]:11 {{.*}} shadowedVar {{.*}}Ref
4964
_ = shadowedVar
5065

66+
// CHECK_LOCALS: [[@LINE+4]]:14 {{.*}} s:14swift_ide_test12ShadowedTestV11shadowedVarSiSgSgvp {{.*}}Ref
67+
// CHECK_LOCALS: [[@LINE+3]]:14 | variable(local)/Swift {{.*}} s:14swift_ide_test12ShadowedTestV06shadowE0yyFyycfU_11shadowedVarL_SiSgSgvp {{.*}}Def
5168
// CHECK-NOT: [[@LINE+2]]:14 {{.*}} shadowedVar {{.*}}Def
5269
// CHECK: [[@LINE+1]]:14 {{.*}} s:14swift_ide_test12ShadowedTestV11shadowedVarSiSgSgvp {{.*}}Ref
5370
_ = { [shadowedVar] in
54-
// CHECK: [[@LINE+1]]:13 {{.*}} s:14swift_ide_test12ShadowedTestV11shadowedVarSiSgSgvp {{.*}}Ref
71+
// CHECK_LOCALS: [[@LINE+2]]:13 {{.*}} s:14swift_ide_test12ShadowedTestV06shadowE0yyFyycfU_11shadowedVarL_SiSgSgvp {{.*}}Ref
72+
// CHECK-NOT: [[@LINE+1]]:13 {{.*}} shadowedVar {{.*}}Ref
5573
_ = shadowedVar
5674
}
5775
}
5876
}
5977

6078
func nestedFuncTest() {
61-
// CHECK: [[@LINE+1]]:10 {{.*}} s:14swift_ide_test12ShadowedTestV010nestedFuncE0yyF08shadowedG0L_yyF {{.*}}Def
79+
// CHECK_LOCALS: [[@LINE+1]]:10 {{.*}} s:14swift_ide_test12ShadowedTestV010nestedFuncE0yyF08shadowedG0L_yyF {{.*}}Def
6280
func shadowedFunc() {
63-
// CHECK-NOT: [[@LINE+2]]:14 {{.*}} shadowedFunc {{.*}}Def
64-
// CHECK: [[@LINE+1]]:14 {{.*}} s:14swift_ide_test12ShadowedTestV010nestedFuncE0yyF08shadowedG0L_yyF {{.*}}Ref
81+
// CHECK_LOCALS: [[@LINE+1]]:14 | variable(local)/Swift {{.*}} s:14swift_ide_test12ShadowedTestV010nestedFuncE0yyF08shadowedG0L_yyFAEL_yycvp {{.*}}Def
6582
_ = { [shadowedFunc] in
66-
// CHECK: [[@LINE+1]]:13 {{.*}} s:14swift_ide_test12ShadowedTestV010nestedFuncE0yyF08shadowedG0L_yyF {{.*}}Ref
83+
// CHECK-NOT: [[@LINE+2]]:14 {{.*}} shadowedFunc {{.*}}Def
84+
// CHECK_LOCALS: [[@LINE+1]]:13 {{.*}} s:14swift_ide_test12ShadowedTestV010nestedFuncE0yyF08shadowedG0L_yyFAEL_yycvp {{.*}}Ref
6785
_ = shadowedFunc
6886
}
6987
}

0 commit comments

Comments
 (0)