Coverage Report

Created: 2021-09-21 08:58

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/Tooling/Refactoring/Rename/USRLocFinder.cpp
Line
Count
Source (jump to first uncovered line)
1
//===--- USRLocFinder.cpp - Clang refactoring library ---------------------===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
///
9
/// \file
10
/// Methods for finding all instances of a USR. Our strategy is very
11
/// simple; we just compare the USR at every relevant AST node with the one
12
/// provided.
13
///
14
//===----------------------------------------------------------------------===//
15
16
#include "clang/Tooling/Refactoring/Rename/USRLocFinder.h"
17
#include "clang/AST/ASTContext.h"
18
#include "clang/AST/ParentMapContext.h"
19
#include "clang/AST/RecursiveASTVisitor.h"
20
#include "clang/Basic/LLVM.h"
21
#include "clang/Basic/SourceLocation.h"
22
#include "clang/Basic/SourceManager.h"
23
#include "clang/Lex/Lexer.h"
24
#include "clang/Tooling/Refactoring/Lookup.h"
25
#include "clang/Tooling/Refactoring/RecursiveSymbolVisitor.h"
26
#include "clang/Tooling/Refactoring/Rename/SymbolName.h"
27
#include "clang/Tooling/Refactoring/Rename/USRFinder.h"
28
#include "llvm/ADT/StringRef.h"
29
#include "llvm/Support/Casting.h"
30
#include <cstddef>
31
#include <set>
32
#include <string>
33
#include <vector>
34
35
using namespace llvm;
36
37
namespace clang {
38
namespace tooling {
39
40
namespace {
41
42
// Returns true if the given Loc is valid for edit. We don't edit the
43
// SourceLocations that are valid or in temporary buffer.
44
551
bool IsValidEditLoc(const clang::SourceManager& SM, clang::SourceLocation Loc) {
45
551
  if (Loc.isInvalid())
46
0
    return false;
47
551
  const clang::FullSourceLoc FullLoc(Loc, SM);
48
551
  std::pair<clang::FileID, unsigned> FileIdAndOffset =
49
551
      FullLoc.getSpellingLoc().getDecomposedLoc();
50
551
  return SM.getFileEntryForID(FileIdAndOffset.first) != nullptr;
51
551
}
52
53
// This visitor recursively searches for all instances of a USR in a
54
// translation unit and stores them for later usage.
55
class USRLocFindingASTVisitor
56
    : public RecursiveSymbolVisitor<USRLocFindingASTVisitor> {
57
public:
58
  explicit USRLocFindingASTVisitor(const std::vector<std::string> &USRs,
59
                                   StringRef PrevName,
60
                                   const ASTContext &Context)
61
      : RecursiveSymbolVisitor(Context.getSourceManager(),
62
                               Context.getLangOpts()),
63
84
        USRSet(USRs.begin(), USRs.end()), PrevName(PrevName), Context(Context) {
64
84
  }
65
66
  bool visitSymbolOccurrence(const NamedDecl *ND,
67
1.52k
                             ArrayRef<SourceRange> NameRanges) {
68
1.52k
    if (USRSet.find(getUSRForDecl(ND)) != USRSet.end()) {
69
460
      assert(NameRanges.size() == 1 &&
70
460
             "Multiple name pieces are not supported yet!");
71
0
      SourceLocation Loc = NameRanges[0].getBegin();
72
460
      const SourceManager &SM = Context.getSourceManager();
73
      // TODO: Deal with macro occurrences correctly.
74
460
      if (Loc.isMacroID())
75
16
        Loc = SM.getSpellingLoc(Loc);
76
460
      checkAndAddLocation(Loc);
77
460
    }
78
0
    return true;
79
1.52k
  }
80
81
  // Non-visitors:
82
83
  /// Returns a set of unique symbol occurrences. Duplicate or
84
  /// overlapping occurrences are erroneous and should be reported!
85
84
  SymbolOccurrences takeOccurrences() { return std::move(Occurrences); }
86
87
private:
88
460
  void checkAndAddLocation(SourceLocation Loc) {
89
460
    const SourceLocation BeginLoc = Loc;
90
460
    const SourceLocation EndLoc = Lexer::getLocForEndOfToken(
91
460
        BeginLoc, 0, Context.getSourceManager(), Context.getLangOpts());
92
460
    StringRef TokenName =
93
460
        Lexer::getSourceText(CharSourceRange::getTokenRange(BeginLoc, EndLoc),
94
460
                             Context.getSourceManager(), Context.getLangOpts());
95
460
    size_t Offset = TokenName.find(PrevName.getNamePieces()[0]);
96
97
    // The token of the source location we find actually has the old
98
    // name.
99
460
    if (Offset != StringRef::npos)
100
459
      Occurrences.emplace_back(PrevName, SymbolOccurrence::MatchingSymbol,
101
459
                               BeginLoc.getLocWithOffset(Offset));
102
460
  }
103
104
  const std::set<std::string> USRSet;
105
  const SymbolName PrevName;
106
  SymbolOccurrences Occurrences;
107
  const ASTContext &Context;
108
};
109
110
215
SourceLocation StartLocationForType(TypeLoc TL) {
111
  // For elaborated types (e.g. `struct a::A`) we want the portion after the
112
  // `struct` but including the namespace qualifier, `a::`.
113
215
  if (auto ElaboratedTypeLoc = TL.getAs<clang::ElaboratedTypeLoc>()) {
114
151
    NestedNameSpecifierLoc NestedNameSpecifier =
115
151
        ElaboratedTypeLoc.getQualifierLoc();
116
151
    if (NestedNameSpecifier.getNestedNameSpecifier())
117
149
      return NestedNameSpecifier.getBeginLoc();
118
2
    TL = TL.getNextTypeLoc();
119
2
  }
120
66
  return TL.getBeginLoc();
121
215
}
122
123
302
SourceLocation EndLocationForType(TypeLoc TL) {
124
  // Dig past any namespace or keyword qualifications.
125
453
  while (TL.getTypeLocClass() == TypeLoc::Elaborated ||
126
453
         
TL.getTypeLocClass() == TypeLoc::Qualified302
)
127
151
    TL = TL.getNextTypeLoc();
128
129
  // The location for template specializations (e.g. Foo<int>) includes the
130
  // templated types in its location range.  We want to restrict this to just
131
  // before the `<` character.
132
302
  if (TL.getTypeLocClass() == TypeLoc::TemplateSpecialization) {
133
31
    return TL.castAs<TemplateSpecializationTypeLoc>()
134
31
        .getLAngleLoc()
135
31
        .getLocWithOffset(-1);
136
31
  }
137
271
  return TL.getEndLoc();
138
302
}
139
140
214
NestedNameSpecifier *GetNestedNameForType(TypeLoc TL) {
141
  // Dig past any keyword qualifications.
142
214
  while (TL.getTypeLocClass() == TypeLoc::Qualified)
143
0
    TL = TL.getNextTypeLoc();
144
145
  // For elaborated types (e.g. `struct a::A`) we want the portion after the
146
  // `struct` but including the namespace qualifier, `a::`.
147
214
  if (auto ElaboratedTypeLoc = TL.getAs<clang::ElaboratedTypeLoc>())
148
151
    return ElaboratedTypeLoc.getQualifierLoc().getNestedNameSpecifier();
149
63
  return nullptr;
150
214
}
151
152
// Find all locations identified by the given USRs for rename.
153
//
154
// This class will traverse the AST and find every AST node whose USR is in the
155
// given USRs' set.
156
class RenameLocFinder : public RecursiveASTVisitor<RenameLocFinder> {
157
public:
158
  RenameLocFinder(llvm::ArrayRef<std::string> USRs, ASTContext &Context)
159
261
      : USRSet(USRs.begin(), USRs.end()), Context(Context) {}
160
161
  // A structure records all information of a symbol reference being renamed.
162
  // We try to add as few prefix qualifiers as possible.
163
  struct RenameInfo {
164
    // The begin location of a symbol being renamed.
165
    SourceLocation Begin;
166
    // The end location of a symbol being renamed.
167
    SourceLocation End;
168
    // The declaration of a symbol being renamed (can be nullptr).
169
    const NamedDecl *FromDecl;
170
    // The declaration in which the nested name is contained (can be nullptr).
171
    const Decl *Context;
172
    // The nested name being replaced (can be nullptr).
173
    const NestedNameSpecifier *Specifier;
174
    // Determine whether the prefix qualifiers of the NewName should be ignored.
175
    // Normally, we set it to true for the symbol declaration and definition to
176
    // avoid adding prefix qualifiers.
177
    // For example, if it is true and NewName is "a::b::foo", then the symbol
178
    // occurrence which the RenameInfo points to will be renamed to "foo".
179
    bool IgnorePrefixQualifers;
180
  };
181
182
6.28k
  bool VisitNamedDecl(const NamedDecl *Decl) {
183
    // UsingDecl has been handled in other place.
184
6.28k
    if (llvm::isa<UsingDecl>(Decl))
185
19
      return true;
186
187
    // DestructorDecl has been handled in Typeloc.
188
6.26k
    if (llvm::isa<CXXDestructorDecl>(Decl))
189
6
      return true;
190
191
6.25k
    if (Decl->isImplicit())
192
0
      return true;
193
194
6.25k
    if (isInUSRSet(Decl)) {
195
      // For the case of renaming an alias template, we actually rename the
196
      // underlying alias declaration of the template.
197
305
      if (const auto* TAT = dyn_cast<TypeAliasTemplateDecl>(Decl))
198
3
        Decl = TAT->getTemplatedDecl();
199
200
305
      auto StartLoc = Decl->getLocation();
201
305
      auto EndLoc = StartLoc;
202
305
      if (IsValidEditLoc(Context.getSourceManager(), StartLoc)) {
203
304
        RenameInfo Info = {StartLoc,
204
304
                           EndLoc,
205
304
                           /*FromDecl=*/nullptr,
206
304
                           /*Context=*/nullptr,
207
304
                           /*Specifier=*/nullptr,
208
304
                           /*IgnorePrefixQualifers=*/true};
209
304
        RenameInfos.push_back(Info);
210
304
      }
211
305
    }
212
6.25k
    return true;
213
6.25k
  }
214
215
25
  bool VisitMemberExpr(const MemberExpr *Expr) {
216
25
    const NamedDecl *Decl = Expr->getFoundDecl();
217
25
    auto StartLoc = Expr->getMemberLoc();
218
25
    auto EndLoc = Expr->getMemberLoc();
219
25
    if (isInUSRSet(Decl)) {
220
15
      RenameInfos.push_back({StartLoc, EndLoc,
221
15
                            /*FromDecl=*/nullptr,
222
15
                            /*Context=*/nullptr,
223
15
                            /*Specifier=*/nullptr,
224
15
                            /*IgnorePrefixQualifiers=*/true});
225
15
    }
226
25
    return true;
227
25
  }
228
229
1
  bool VisitDesignatedInitExpr(const DesignatedInitExpr *E) {
230
1
    for (const DesignatedInitExpr::Designator &D : E->designators()) {
231
1
      if (D.isFieldDesignator() && D.getField()) {
232
1
        const FieldDecl *Decl = D.getField();
233
1
        if (isInUSRSet(Decl)) {
234
1
          auto StartLoc = D.getFieldLoc();
235
1
          auto EndLoc = D.getFieldLoc();
236
1
          RenameInfos.push_back({StartLoc, EndLoc,
237
1
                                 /*FromDecl=*/nullptr,
238
1
                                 /*Context=*/nullptr,
239
1
                                 /*Specifier=*/nullptr,
240
1
                                 /*IgnorePrefixQualifiers=*/true});
241
1
        }
242
1
      }
243
1
    }
244
1
    return true;
245
1
  }
246
247
11
  bool VisitCXXConstructorDecl(const CXXConstructorDecl *CD) {
248
    // Fix the constructor initializer when renaming class members.
249
11
    for (const auto *Initializer : CD->inits()) {
250
      // Ignore implicit initializers.
251
4
      if (!Initializer->isWritten())
252
1
        continue;
253
254
3
      if (const FieldDecl *FD = Initializer->getMember()) {
255
3
        if (isInUSRSet(FD)) {
256
1
          auto Loc = Initializer->getSourceLocation();
257
1
          RenameInfos.push_back({Loc, Loc,
258
1
                                 /*FromDecl=*/nullptr,
259
1
                                 /*Context=*/nullptr,
260
1
                                 /*Specifier=*/nullptr,
261
1
                                 /*IgnorePrefixQualifiers=*/true});
262
1
        }
263
3
      }
264
3
    }
265
11
    return true;
266
11
  }
267
268
193
  bool VisitDeclRefExpr(const DeclRefExpr *Expr) {
269
193
    const NamedDecl *Decl = Expr->getFoundDecl();
270
    // Get the underlying declaration of the shadow declaration introduced by a
271
    // using declaration.
272
193
    if (auto *UsingShadow = llvm::dyn_cast<UsingShadowDecl>(Decl)) {
273
1
      Decl = UsingShadow->getTargetDecl();
274
1
    }
275
276
193
    auto StartLoc = Expr->getBeginLoc();
277
    // For template function call expressions like `foo<int>()`, we want to
278
    // restrict the end of location to just before the `<` character.
279
193
    SourceLocation EndLoc = Expr->hasExplicitTemplateArgs()
280
193
                                ? 
Expr->getLAngleLoc().getLocWithOffset(-1)10
281
193
                                : 
Expr->getEndLoc()183
;
282
283
193
    if (const auto *MD = llvm::dyn_cast<CXXMethodDecl>(Decl)) {
284
44
      if (isInUSRSet(MD)) {
285
        // Handle renaming static template class methods, we only rename the
286
        // name without prefix qualifiers and restrict the source range to the
287
        // name.
288
21
        RenameInfos.push_back({EndLoc, EndLoc,
289
21
                               /*FromDecl=*/nullptr,
290
21
                               /*Context=*/nullptr,
291
21
                               /*Specifier=*/nullptr,
292
21
                               /*IgnorePrefixQualifiers=*/true});
293
21
        return true;
294
21
      }
295
44
    }
296
297
    // In case of renaming an enum declaration, we have to explicitly handle
298
    // unscoped enum constants referenced in expressions (e.g.
299
    // "auto r = ns1::ns2::Green" where Green is an enum constant of an unscoped
300
    // enum decl "ns1::ns2::Color") as these enum constants cannot be caught by
301
    // TypeLoc.
302
172
    if (const auto *T = llvm::dyn_cast<EnumConstantDecl>(Decl)) {
303
      // FIXME: Handle the enum constant without prefix qualifiers (`a = Green`)
304
      // when renaming an unscoped enum declaration with a new namespace.
305
17
      if (!Expr->hasQualifier())
306
2
        return true;
307
308
15
      if (const auto *ED =
309
15
              llvm::dyn_cast_or_null<EnumDecl>(getClosestAncestorDecl(*T))) {
310
15
        if (ED->isScoped())
311
4
          return true;
312
11
        Decl = ED;
313
11
      }
314
      // The current fix would qualify "ns1::ns2::Green" as
315
      // "ns1::ns2::Color::Green".
316
      //
317
      // Get the EndLoc of the replacement by moving 1 character backward (
318
      // to exclude the last '::').
319
      //
320
      //    ns1::ns2::Green;
321
      //    ^      ^^
322
      // BeginLoc  |EndLoc of the qualifier
323
      //           new EndLoc
324
11
      EndLoc = Expr->getQualifierLoc().getEndLoc().getLocWithOffset(-1);
325
11
      assert(EndLoc.isValid() &&
326
11
             "The enum constant should have prefix qualifers.");
327
11
    }
328
166
    if (isInUSRSet(Decl) &&
329
166
        
IsValidEditLoc(Context.getSourceManager(), StartLoc)31
) {
330
31
      RenameInfo Info = {StartLoc,
331
31
                         EndLoc,
332
31
                         Decl,
333
31
                         getClosestAncestorDecl(*Expr),
334
31
                         Expr->getQualifier(),
335
31
                         /*IgnorePrefixQualifers=*/false};
336
31
      RenameInfos.push_back(Info);
337
31
    }
338
339
166
    return true;
340
172
  }
341
342
19
  bool VisitUsingDecl(const UsingDecl *Using) {
343
21
    for (const auto *UsingShadow : Using->shadows()) {
344
21
      if (isInUSRSet(UsingShadow->getTargetDecl())) {
345
18
        UsingDecls.push_back(Using);
346
18
        break;
347
18
      }
348
21
    }
349
19
    return true;
350
19
  }
351
352
134
  bool VisitNestedNameSpecifierLocations(NestedNameSpecifierLoc NestedLoc) {
353
134
    if (!NestedLoc.getNestedNameSpecifier()->getAsType())
354
0
      return true;
355
356
134
    if (const auto *TargetDecl =
357
134
            getSupportedDeclFromTypeLoc(NestedLoc.getTypeLoc())) {
358
132
      if (isInUSRSet(TargetDecl)) {
359
87
        RenameInfo Info = {NestedLoc.getBeginLoc(),
360
87
                           EndLocationForType(NestedLoc.getTypeLoc()),
361
87
                           TargetDecl,
362
87
                           getClosestAncestorDecl(NestedLoc),
363
87
                           NestedLoc.getNestedNameSpecifier()->getPrefix(),
364
87
                           /*IgnorePrefixQualifers=*/false};
365
87
        RenameInfos.push_back(Info);
366
87
      }
367
132
    }
368
134
    return true;
369
134
  }
370
371
5.21k
  bool VisitTypeLoc(TypeLoc Loc) {
372
5.21k
    auto Parents = Context.getParents(Loc);
373
5.21k
    TypeLoc ParentTypeLoc;
374
5.21k
    if (!Parents.empty()) {
375
      // Handle cases of nested name specificier locations.
376
      //
377
      // The VisitNestedNameSpecifierLoc interface is not impelmented in
378
      // RecursiveASTVisitor, we have to handle it explicitly.
379
5.17k
      if (const auto *NSL = Parents[0].get<NestedNameSpecifierLoc>()) {
380
134
        VisitNestedNameSpecifierLocations(*NSL);
381
134
        return true;
382
134
      }
383
384
5.04k
      if (const auto *TL = Parents[0].get<TypeLoc>())
385
2.31k
        ParentTypeLoc = *TL;
386
5.04k
    }
387
388
    // Handle the outermost TypeLoc which is directly linked to the interesting
389
    // declaration and don't handle nested name specifier locations.
390
5.08k
    if (const auto *TargetDecl = getSupportedDeclFromTypeLoc(Loc)) {
391
1.04k
      if (isInUSRSet(TargetDecl)) {
392
        // Only handle the outermost typeLoc.
393
        //
394
        // For a type like "a::Foo", there will be two typeLocs for it.
395
        // One ElaboratedType, the other is RecordType:
396
        //
397
        //   ElaboratedType 0x33b9390 'a::Foo' sugar
398
        //   `-RecordType 0x338fef0 'class a::Foo'
399
        //     `-CXXRecord 0x338fe58 'Foo'
400
        //
401
        // Skip if this is an inner typeLoc.
402
360
        if (!ParentTypeLoc.isNull() &&
403
360
            
isInUSRSet(getSupportedDeclFromTypeLoc(ParentTypeLoc))193
)
404
149
          return true;
405
406
211
        auto StartLoc = StartLocationForType(Loc);
407
211
        auto EndLoc = EndLocationForType(Loc);
408
211
        if (IsValidEditLoc(Context.getSourceManager(), StartLoc)) {
409
210
          RenameInfo Info = {StartLoc,
410
210
                             EndLoc,
411
210
                             TargetDecl,
412
210
                             getClosestAncestorDecl(Loc),
413
210
                             GetNestedNameForType(Loc),
414
210
                             /*IgnorePrefixQualifers=*/false};
415
210
          RenameInfos.push_back(Info);
416
210
        }
417
211
        return true;
418
360
      }
419
1.04k
    }
420
421
    // Handle specific template class specialiation cases.
422
4.72k
    if (const auto *TemplateSpecType =
423
4.72k
            dyn_cast<TemplateSpecializationType>(Loc.getType())) {
424
152
      TypeLoc TargetLoc = Loc;
425
152
      if (!ParentTypeLoc.isNull()) {
426
4
        if (llvm::isa<ElaboratedType>(ParentTypeLoc.getType()))
427
4
          TargetLoc = ParentTypeLoc;
428
4
      }
429
430
152
      if (isInUSRSet(TemplateSpecType->getTemplateName().getAsTemplateDecl())) {
431
4
        TypeLoc TargetLoc = Loc;
432
        // FIXME: Find a better way to handle this case.
433
        // For the qualified template class specification type like
434
        // "ns::Foo<int>" in "ns::Foo<int>& f();", we want the parent typeLoc
435
        // (ElaboratedType) of the TemplateSpecializationType in order to
436
        // catch the prefix qualifiers "ns::".
437
4
        if (!ParentTypeLoc.isNull() &&
438
4
            
llvm::isa<ElaboratedType>(ParentTypeLoc.getType())2
)
439
2
          TargetLoc = ParentTypeLoc;
440
441
4
        auto StartLoc = StartLocationForType(TargetLoc);
442
4
        auto EndLoc = EndLocationForType(TargetLoc);
443
4
        if (IsValidEditLoc(Context.getSourceManager(), StartLoc)) {
444
4
          RenameInfo Info = {
445
4
              StartLoc,
446
4
              EndLoc,
447
4
              TemplateSpecType->getTemplateName().getAsTemplateDecl(),
448
4
              getClosestAncestorDecl(DynTypedNode::create(TargetLoc)),
449
4
              GetNestedNameForType(TargetLoc),
450
4
              /*IgnorePrefixQualifers=*/false};
451
4
          RenameInfos.push_back(Info);
452
4
        }
453
4
      }
454
152
    }
455
4.72k
    return true;
456
5.08k
  }
457
458
  // Returns a list of RenameInfo.
459
261
  const std::vector<RenameInfo> &getRenameInfos() const { return RenameInfos; }
460
461
  // Returns a list of using declarations which are needed to update.
462
261
  const std::vector<const UsingDecl *> &getUsingDecls() const {
463
261
    return UsingDecls;
464
261
  }
465
466
private:
467
  // Get the supported declaration from a given typeLoc. If the declaration type
468
  // is not supported, returns nullptr.
469
5.41k
  const NamedDecl *getSupportedDeclFromTypeLoc(TypeLoc Loc) {
470
5.41k
    if (const auto* TT = Loc.getType()->getAs<clang::TypedefType>())
471
177
      return TT->getDecl();
472
5.23k
    if (const auto *RD = Loc.getType()->getAsCXXRecordDecl())
473
1.03k
      return RD;
474
4.19k
    if (const auto *ED =
475
4.19k
            llvm::dyn_cast_or_null<EnumDecl>(Loc.getType()->getAsTagDecl()))
476
127
      return ED;
477
4.07k
    return nullptr;
478
4.19k
  }
479
480
  // Get the closest ancester which is a declaration of a given AST node.
481
  template <typename ASTNodeType>
482
646
  const Decl *getClosestAncestorDecl(const ASTNodeType &Node) {
483
646
    auto Parents = Context.getParents(Node);
484
    // FIXME: figure out how to handle it when there are multiple parents.
485
646
    if (Parents.size() != 1)
486
9
      return nullptr;
487
637
    if (ASTNodeKind::getFromNodeKind<Decl>().isBaseOf(Parents[0].getNodeKind()))
488
338
      return Parents[0].template get<Decl>();
489
299
    return getClosestAncestorDecl(Parents[0]);
490
637
  }
USRLocFinder.cpp:clang::Decl const* clang::tooling::(anonymous namespace)::RenameLocFinder::getClosestAncestorDecl<clang::NestedNameSpecifierLoc>(clang::NestedNameSpecifierLoc const&)
Line
Count
Source
482
87
  const Decl *getClosestAncestorDecl(const ASTNodeType &Node) {
483
87
    auto Parents = Context.getParents(Node);
484
    // FIXME: figure out how to handle it when there are multiple parents.
485
87
    if (Parents.size() != 1)
486
0
      return nullptr;
487
87
    if (ASTNodeKind::getFromNodeKind<Decl>().isBaseOf(Parents[0].getNodeKind()))
488
54
      return Parents[0].template get<Decl>();
489
33
    return getClosestAncestorDecl(Parents[0]);
490
87
  }
USRLocFinder.cpp:clang::Decl const* clang::tooling::(anonymous namespace)::RenameLocFinder::getClosestAncestorDecl<clang::TypeLoc>(clang::TypeLoc const&)
Line
Count
Source
482
210
  const Decl *getClosestAncestorDecl(const ASTNodeType &Node) {
483
210
    auto Parents = Context.getParents(Node);
484
    // FIXME: figure out how to handle it when there are multiple parents.
485
210
    if (Parents.size() != 1)
486
9
      return nullptr;
487
201
    if (ASTNodeKind::getFromNodeKind<Decl>().isBaseOf(Parents[0].getNodeKind()))
488
134
      return Parents[0].template get<Decl>();
489
67
    return getClosestAncestorDecl(Parents[0]);
490
201
  }
USRLocFinder.cpp:clang::Decl const* clang::tooling::(anonymous namespace)::RenameLocFinder::getClosestAncestorDecl<clang::DynTypedNode>(clang::DynTypedNode const&)
Line
Count
Source
482
303
  const Decl *getClosestAncestorDecl(const ASTNodeType &Node) {
483
303
    auto Parents = Context.getParents(Node);
484
    // FIXME: figure out how to handle it when there are multiple parents.
485
303
    if (Parents.size() != 1)
486
0
      return nullptr;
487
303
    if (ASTNodeKind::getFromNodeKind<Decl>().isBaseOf(Parents[0].getNodeKind()))
488
128
      return Parents[0].template get<Decl>();
489
175
    return getClosestAncestorDecl(Parents[0]);
490
303
  }
USRLocFinder.cpp:clang::Decl const* clang::tooling::(anonymous namespace)::RenameLocFinder::getClosestAncestorDecl<clang::EnumConstantDecl>(clang::EnumConstantDecl const&)
Line
Count
Source
482
15
  const Decl *getClosestAncestorDecl(const ASTNodeType &Node) {
483
15
    auto Parents = Context.getParents(Node);
484
    // FIXME: figure out how to handle it when there are multiple parents.
485
15
    if (Parents.size() != 1)
486
0
      return nullptr;
487
15
    if (ASTNodeKind::getFromNodeKind<Decl>().isBaseOf(Parents[0].getNodeKind()))
488
15
      return Parents[0].template get<Decl>();
489
0
    return getClosestAncestorDecl(Parents[0]);
490
15
  }
USRLocFinder.cpp:clang::Decl const* clang::tooling::(anonymous namespace)::RenameLocFinder::getClosestAncestorDecl<clang::DeclRefExpr>(clang::DeclRefExpr const&)
Line
Count
Source
482
31
  const Decl *getClosestAncestorDecl(const ASTNodeType &Node) {
483
31
    auto Parents = Context.getParents(Node);
484
    // FIXME: figure out how to handle it when there are multiple parents.
485
31
    if (Parents.size() != 1)
486
0
      return nullptr;
487
31
    if (ASTNodeKind::getFromNodeKind<Decl>().isBaseOf(Parents[0].getNodeKind()))
488
7
      return Parents[0].template get<Decl>();
489
24
    return getClosestAncestorDecl(Parents[0]);
490
31
  }
491
492
  // Get the parent typeLoc of a given typeLoc. If there is no such parent,
493
  // return nullptr.
494
0
  const TypeLoc *getParentTypeLoc(TypeLoc Loc) const {
495
0
    auto Parents = Context.getParents(Loc);
496
0
    // FIXME: figure out how to handle it when there are multiple parents.
497
0
    if (Parents.size() != 1)
498
0
      return nullptr;
499
0
    return Parents[0].get<TypeLoc>();
500
0
  }
501
502
  // Check whether the USR of a given Decl is in the USRSet.
503
8.03k
  bool isInUSRSet(const Decl *Decl) const {
504
8.03k
    auto USR = getUSRForDecl(Decl);
505
8.03k
    if (USR.empty())
506
36
      return false;
507
8.00k
    return llvm::is_contained(USRSet, USR);
508
8.03k
  }
509
510
  const std::set<std::string> USRSet;
511
  ASTContext &Context;
512
  std::vector<RenameInfo> RenameInfos;
513
  // Record all interested using declarations which contains the using-shadow
514
  // declarations of the symbol declarations being renamed.
515
  std::vector<const UsingDecl *> UsingDecls;
516
};
517
518
} // namespace
519
520
SymbolOccurrences getOccurrencesOfUSRs(ArrayRef<std::string> USRs,
521
84
                                       StringRef PrevName, Decl *Decl) {
522
84
  USRLocFindingASTVisitor Visitor(USRs, PrevName, Decl->getASTContext());
523
84
  Visitor.TraverseDecl(Decl);
524
84
  return Visitor.takeOccurrences();
525
84
}
526
527
std::vector<tooling::AtomicChange>
528
createRenameAtomicChanges(llvm::ArrayRef<std::string> USRs,
529
261
                          llvm::StringRef NewName, Decl *TranslationUnitDecl) {
530
261
  RenameLocFinder Finder(USRs, TranslationUnitDecl->getASTContext());
531
261
  Finder.TraverseDecl(TranslationUnitDecl);
532
533
261
  const SourceManager &SM =
534
261
      TranslationUnitDecl->getASTContext().getSourceManager();
535
536
261
  std::vector<tooling::AtomicChange> AtomicChanges;
537
261
  auto Replace = [&](SourceLocation Start, SourceLocation End,
538
692
                     llvm::StringRef Text) {
539
692
    tooling::AtomicChange ReplaceChange = tooling::AtomicChange(SM, Start);
540
692
    llvm::Error Err = ReplaceChange.replace(
541
692
        SM, CharSourceRange::getTokenRange(Start, End), Text);
542
692
    if (Err) {
543
0
      llvm::errs() << "Failed to add replacement to AtomicChange: "
544
0
                   << llvm::toString(std::move(Err)) << "\n";
545
0
      return;
546
0
    }
547
692
    AtomicChanges.push_back(std::move(ReplaceChange));
548
692
  };
549
550
674
  for (const auto &RenameInfo : Finder.getRenameInfos()) {
551
674
    std::string ReplacedName = NewName.str();
552
674
    if (RenameInfo.IgnorePrefixQualifers) {
553
      // Get the name without prefix qualifiers from NewName.
554
342
      size_t LastColonPos = NewName.find_last_of(':');
555
342
      if (LastColonPos != std::string::npos)
556
304
        ReplacedName = std::string(NewName.substr(LastColonPos + 1));
557
342
    } else {
558
332
      if (RenameInfo.FromDecl && RenameInfo.Context) {
559
323
        if (!llvm::isa<clang::TranslationUnitDecl>(
560
323
                RenameInfo.Context->getDeclContext())) {
561
226
          ReplacedName = tooling::replaceNestedName(
562
226
              RenameInfo.Specifier, RenameInfo.Begin,
563
226
              RenameInfo.Context->getDeclContext(), RenameInfo.FromDecl,
564
226
              NewName.startswith("::") ? 
NewName.str()18
565
226
                                       : 
("::" + NewName).str()208
);
566
226
        } else {
567
          // This fixes the case where type `T` is a parameter inside a function
568
          // type (e.g. `std::function<void(T)>`) and the DeclContext of `T`
569
          // becomes the translation unit. As a workaround, we simply use
570
          // fully-qualified name here for all references whose `DeclContext` is
571
          // the translation unit and ignore the possible existence of
572
          // using-decls (in the global scope) that can shorten the replaced
573
          // name.
574
97
          llvm::StringRef ActualName = Lexer::getSourceText(
575
97
              CharSourceRange::getTokenRange(
576
97
                  SourceRange(RenameInfo.Begin, RenameInfo.End)),
577
97
              SM, TranslationUnitDecl->getASTContext().getLangOpts());
578
          // Add the leading "::" back if the name written in the code contains
579
          // it.
580
97
          if (ActualName.startswith("::") && 
!NewName.startswith("::")4
) {
581
4
            ReplacedName = "::" + NewName.str();
582
4
          }
583
97
        }
584
323
      }
585
      // If the NewName contains leading "::", add it back.
586
332
      if (NewName.startswith("::") && 
NewName.substr(2) == ReplacedName22
)
587
9
        ReplacedName = NewName.str();
588
332
    }
589
674
    Replace(RenameInfo.Begin, RenameInfo.End, ReplacedName);
590
674
  }
591
592
  // Hanlde using declarations explicitly as "using a::Foo" don't trigger
593
  // typeLoc for "a::Foo".
594
261
  for (const auto *Using : Finder.getUsingDecls())
595
18
    Replace(Using->getBeginLoc(), Using->getEndLoc(), "using " + NewName.str());
596
597
261
  return AtomicChanges;
598
261
}
599
600
} // end namespace tooling
601
} // end namespace clang