clang 17.0.0git
RenamingAction.h
Go to the documentation of this file.
1//===--- RenamingAction.h - 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/// Provides an action to rename every symbol at a point.
11///
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CLANG_TOOLING_REFACTORING_RENAME_RENAMINGACTION_H
15#define LLVM_CLANG_TOOLING_REFACTORING_RENAME_RENAMINGACTION_H
16
22#include "llvm/Support/Error.h"
23
24namespace clang {
25class ASTConsumer;
26
27namespace tooling {
28
30public:
31 RenamingAction(const std::vector<std::string> &NewNames,
32 const std::vector<std::string> &PrevNames,
33 const std::vector<std::vector<std::string>> &USRList,
34 std::map<std::string, tooling::Replacements> &FileToReplaces,
35 bool PrintLocations = false)
36 : NewNames(NewNames), PrevNames(PrevNames), USRList(USRList),
37 FileToReplaces(FileToReplaces), PrintLocations(PrintLocations) {}
38
39 std::unique_ptr<ASTConsumer> newASTConsumer();
40
41private:
42 const std::vector<std::string> &NewNames, &PrevNames;
43 const std::vector<std::vector<std::string>> &USRList;
44 std::map<std::string, tooling::Replacements> &FileToReplaces;
45 bool PrintLocations;
46};
47
49public:
51 SourceRange SelectionRange,
52 std::string NewName);
53
54 static const RefactoringDescriptor &describe();
55
56 const NamedDecl *getRenameDecl() const;
57
58private:
59 RenameOccurrences(const NamedDecl *ND, std::string NewName)
60 : ND(ND), NewName(std::move(NewName)) {}
61
63 createSourceReplacements(RefactoringRuleContext &Context) override;
64
65 const NamedDecl *ND;
66 std::string NewName;
67};
68
70public:
72 std::string OldQualifiedName,
73 std::string NewQualifiedName);
74
75 static const RefactoringDescriptor &describe();
76
77private:
79 std::string NewQualifiedName)
80 : ND(ND), NewQualifiedName(std::move(NewQualifiedName)) {}
81
83 createSourceReplacements(RefactoringRuleContext &Context) override;
84
85 // A NamedDecl which identifies the symbol being renamed.
86 const NamedDecl *ND;
87 // The new qualified name to change the symbol to.
88 std::string NewQualifiedName;
89};
90
91/// Returns source replacements that correspond to the rename of the given
92/// symbol occurrences.
95 const SourceManager &SM, const SymbolName &NewName);
96
97/// Rename all symbols identified by the given USRs.
99public:
101 const std::vector<std::string> &NewNames,
102 const std::vector<std::vector<std::string>> &USRList,
103 std::map<std::string, tooling::Replacements> &FileToReplaces)
104 : NewNames(NewNames), USRList(USRList), FileToReplaces(FileToReplaces) {}
105
106 std::unique_ptr<ASTConsumer> newASTConsumer();
107
108private:
109 /// New symbol names.
110 const std::vector<std::string> &NewNames;
111
112 /// A list of USRs. Each element represents USRs of a symbol being renamed.
113 const std::vector<std::vector<std::string>> &USRList;
114
115 /// A file path to replacements map.
116 std::map<std::string, tooling::Replacements> &FileToReplaces;
117};
118
119} // end namespace tooling
120} // end namespace clang
121
122#endif // LLVM_CLANG_TOOLING_REFACTORING_RENAME_RENAMINGACTION_H
#define SM(sm)
Definition: Cuda.cpp:78
This represents a decl that may have a name.
Definition: Decl.h:247
This class handles loading and caching of source files into memory.
A trivial tuple used to represent a source range.
static Expected< QualifiedRenameRule > initiate(RefactoringRuleContext &Context, std::string OldQualifiedName, std::string NewQualifiedName)
static const RefactoringDescriptor & describe()
Rename all symbols identified by the given USRs.
std::unique_ptr< ASTConsumer > newASTConsumer()
QualifiedRenamingAction(const std::vector< std::string > &NewNames, const std::vector< std::vector< std::string > > &USRList, std::map< std::string, tooling::Replacements > &FileToReplaces)
The refactoring rule context stores all of the inputs that might be needed by a refactoring action ru...
static const RefactoringDescriptor & describe()
const NamedDecl * getRenameDecl() const
static Expected< RenameOccurrences > initiate(RefactoringRuleContext &Context, SourceRange SelectionRange, std::string NewName)
std::unique_ptr< ASTConsumer > newASTConsumer()
RenamingAction(const std::vector< std::string > &NewNames, const std::vector< std::string > &PrevNames, const std::vector< std::vector< std::string > > &USRList, std::map< std::string, tooling::Replacements > &FileToReplaces, bool PrintLocations=false)
A type of refactoring action rule that produces source replacements in the form of atomic changes.
A name of a symbol.
Definition: SymbolName.h:29
llvm::Expected< std::vector< AtomicChange > > createRenameReplacements(const SymbolOccurrences &Occurrences, const SourceManager &SM, const SymbolName &NewName)
Returns source replacements that correspond to the rename of the given symbol occurrences.
std::vector< SymbolOccurrence > SymbolOccurrences