clang  6.0.0svn
RenamingAction.h
Go to the documentation of this file.
1 //===--- RenamingAction.h - Clang refactoring library ---------------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 ///
10 /// \file
11 /// \brief Provides an action to rename every symbol at a point.
12 ///
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_CLANG_TOOLING_REFACTOR_RENAME_RENAMING_ACTION_H
16 #define LLVM_CLANG_TOOLING_REFACTOR_RENAME_RENAMING_ACTION_H
17 
23 #include "llvm/Support/Error.h"
24 
25 namespace clang {
26 class ASTConsumer;
27 class CompilerInstance;
28 
29 namespace tooling {
30 
32 public:
33  RenamingAction(const std::vector<std::string> &NewNames,
34  const std::vector<std::string> &PrevNames,
35  const std::vector<std::vector<std::string>> &USRList,
36  std::map<std::string, tooling::Replacements> &FileToReplaces,
37  bool PrintLocations = false)
38  : NewNames(NewNames), PrevNames(PrevNames), USRList(USRList),
39  FileToReplaces(FileToReplaces), PrintLocations(PrintLocations) {}
40 
41  std::unique_ptr<ASTConsumer> newASTConsumer();
42 
43 private:
44  const std::vector<std::string> &NewNames, &PrevNames;
45  const std::vector<std::vector<std::string>> &USRList;
46  std::map<std::string, tooling::Replacements> &FileToReplaces;
47  bool PrintLocations;
48 };
49 
51 public:
52  static Expected<RenameOccurrences> initiate(RefactoringRuleContext &Context,
53  SourceRange SelectionRange,
54  std::string NewName);
55 
56  static const RefactoringDescriptor &describe();
57 
58 private:
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 
70 public:
72  std::string OldQualifiedName,
73  std::string NewQualifiedName);
74 
75  static const RefactoringDescriptor &describe();
76 
77 private:
79  std::string NewQualifiedName)
80  : ND(ND), NewQualifiedName(std::move(NewQualifiedName)) {}
81 
83  createSourceReplacements(RefactoringRuleContext &Context) override;
84 
85  // A NamedDecl which indentifies the 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.
99 public:
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 
108 private:
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_REFACTOR_RENAME_RENAMING_ACTION_H
A name of a symbol.
Definition: SymbolName.h:30
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)
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)
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.
The refactoring rule context stores all of the inputs that might be needed by a refactoring action ru...
Rename all symbols identified by the given USRs.
const SourceManager & SM
Definition: Format.cpp:1337
Dataflow Directional Tag Classes.
std::vector< SymbolOccurrence > SymbolOccurrences
A type of refactoring action rule that produces source replacements in the form of atomic changes...
A trivial tuple used to represent a source range.
NamedDecl - This represents a decl with a name.
Definition: Decl.h:245
This class handles loading and caching of source files into memory.