blob: 8599f975120653a48edd35338c13e8d5ef6ff385 [file] [log] [blame]
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +00001//===--- Refactoring.cpp - Framework for clang refactoring tools ----------===//
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// Implements tools to support refactorings.
11//
12//===----------------------------------------------------------------------===//
13
Douglas Gregor02c23eb2012-10-23 22:26:28 +000014#include "clang/Basic/DiagnosticOptions.h"
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +000015#include "clang/Basic/FileManager.h"
16#include "clang/Basic/SourceManager.h"
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +000017#include "clang/Frontend/TextDiagnosticPrinter.h"
18#include "clang/Lex/Lexer.h"
Ted Kremenek305c6132012-09-01 05:09:24 +000019#include "clang/Rewrite/Core/Rewriter.h"
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +000020#include "clang/Tooling/Refactoring.h"
21#include "llvm/Support/raw_os_ostream.h"
22
23namespace clang {
24namespace tooling {
25
26static const char * const InvalidLocation = "";
27
28Replacement::Replacement()
Daniel Jasper8a999452013-05-16 10:40:07 +000029 : FilePath(InvalidLocation) {}
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +000030
Daniel Jasper8a999452013-05-16 10:40:07 +000031Replacement::Replacement(StringRef FilePath, unsigned Offset, unsigned Length,
32 StringRef ReplacementText)
33 : FilePath(FilePath), ReplacementRange(Offset, Length),
34 ReplacementText(ReplacementText) {}
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +000035
36Replacement::Replacement(SourceManager &Sources, SourceLocation Start,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +000037 unsigned Length, StringRef ReplacementText) {
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +000038 setFromSourceLocation(Sources, Start, Length, ReplacementText);
39}
40
41Replacement::Replacement(SourceManager &Sources, const CharSourceRange &Range,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +000042 StringRef ReplacementText) {
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +000043 setFromSourceRange(Sources, Range, ReplacementText);
44}
45
46bool Replacement::isApplicable() const {
47 return FilePath != InvalidLocation;
48}
49
50bool Replacement::apply(Rewriter &Rewrite) const {
51 SourceManager &SM = Rewrite.getSourceMgr();
52 const FileEntry *Entry = SM.getFileManager().getFile(FilePath);
53 if (Entry == NULL)
54 return false;
55 FileID ID;
56 // FIXME: Use SM.translateFile directly.
57 SourceLocation Location = SM.translateFileLineCol(Entry, 1, 1);
58 ID = Location.isValid() ?
59 SM.getFileID(Location) :
60 SM.createFileID(Entry, SourceLocation(), SrcMgr::C_User);
61 // FIXME: We cannot check whether Offset + Length is in the file, as
62 // the remapping API is not public in the RewriteBuffer.
63 const SourceLocation Start =
64 SM.getLocForStartOfFile(ID).
Daniel Jasper8a999452013-05-16 10:40:07 +000065 getLocWithOffset(ReplacementRange.getOffset());
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +000066 // ReplaceText returns false on success.
67 // ReplaceText only fails if the source location is not a file location, in
68 // which case we already returned false earlier.
Daniel Jasper8a999452013-05-16 10:40:07 +000069 bool RewriteSucceeded = !Rewrite.ReplaceText(
70 Start, ReplacementRange.getLength(), ReplacementText);
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +000071 assert(RewriteSucceeded);
72 return RewriteSucceeded;
73}
74
Manuel Klimek5d51e882012-05-30 16:04:29 +000075std::string Replacement::toString() const {
76 std::string result;
77 llvm::raw_string_ostream stream(result);
Daniel Jasper8a999452013-05-16 10:40:07 +000078 stream << FilePath << ": " << ReplacementRange.getOffset() << ":+"
79 << ReplacementRange.getLength() << ":\"" << ReplacementText << "\"";
Manuel Klimek5d51e882012-05-30 16:04:29 +000080 return result;
81}
82
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +000083bool Replacement::Less::operator()(const Replacement &R1,
84 const Replacement &R2) const {
85 if (R1.FilePath != R2.FilePath) return R1.FilePath < R2.FilePath;
Daniel Jasper8a999452013-05-16 10:40:07 +000086 if (R1.ReplacementRange.getOffset() != R2.ReplacementRange.getOffset())
87 return R1.ReplacementRange.getOffset() < R2.ReplacementRange.getOffset();
88 if (R1.ReplacementRange.getLength() != R2.ReplacementRange.getLength())
89 return R1.ReplacementRange.getLength() < R2.ReplacementRange.getLength();
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +000090 return R1.ReplacementText < R2.ReplacementText;
91}
92
Edwin Vaned5692db2013-08-08 13:31:14 +000093bool Replacement::operator==(const Replacement &Other) const {
94 return ReplacementRange.getOffset() == Other.ReplacementRange.getOffset() &&
95 ReplacementRange.getLength() == Other.ReplacementRange.getLength() &&
96 FilePath == Other.FilePath && ReplacementText == Other.ReplacementText;
97}
98
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +000099void Replacement::setFromSourceLocation(SourceManager &Sources,
100 SourceLocation Start, unsigned Length,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000101 StringRef ReplacementText) {
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +0000102 const std::pair<FileID, unsigned> DecomposedLocation =
103 Sources.getDecomposedLoc(Start);
104 const FileEntry *Entry = Sources.getFileEntryForID(DecomposedLocation.first);
105 this->FilePath = Entry != NULL ? Entry->getName() : InvalidLocation;
Daniel Jasper8a999452013-05-16 10:40:07 +0000106 this->ReplacementRange = Range(DecomposedLocation.second, Length);
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +0000107 this->ReplacementText = ReplacementText;
108}
109
110// FIXME: This should go into the Lexer, but we need to figure out how
111// to handle ranges for refactoring in general first - there is no obvious
112// good way how to integrate this into the Lexer yet.
113static int getRangeSize(SourceManager &Sources, const CharSourceRange &Range) {
114 SourceLocation SpellingBegin = Sources.getSpellingLoc(Range.getBegin());
115 SourceLocation SpellingEnd = Sources.getSpellingLoc(Range.getEnd());
116 std::pair<FileID, unsigned> Start = Sources.getDecomposedLoc(SpellingBegin);
117 std::pair<FileID, unsigned> End = Sources.getDecomposedLoc(SpellingEnd);
118 if (Start.first != End.first) return -1;
119 if (Range.isTokenRange())
120 End.second += Lexer::MeasureTokenLength(SpellingEnd, Sources,
121 LangOptions());
122 return End.second - Start.second;
123}
124
125void Replacement::setFromSourceRange(SourceManager &Sources,
126 const CharSourceRange &Range,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000127 StringRef ReplacementText) {
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +0000128 setFromSourceLocation(Sources, Sources.getSpellingLoc(Range.getBegin()),
129 getRangeSize(Sources, Range), ReplacementText);
130}
131
David Blaikie76a2ea32013-07-17 18:29:58 +0000132bool applyAllReplacements(const Replacements &Replaces, Rewriter &Rewrite) {
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +0000133 bool Result = true;
134 for (Replacements::const_iterator I = Replaces.begin(),
135 E = Replaces.end();
136 I != E; ++I) {
137 if (I->isApplicable()) {
138 Result = I->apply(Rewrite) && Result;
139 } else {
140 Result = false;
141 }
142 }
143 return Result;
144}
145
David Blaikie76a2ea32013-07-17 18:29:58 +0000146std::string applyAllReplacements(StringRef Code, const Replacements &Replaces) {
Daniel Jasper8a999452013-05-16 10:40:07 +0000147 FileManager Files((FileSystemOptions()));
148 DiagnosticsEngine Diagnostics(
149 IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs),
150 new DiagnosticOptions);
151 Diagnostics.setClient(new TextDiagnosticPrinter(
152 llvm::outs(), &Diagnostics.getDiagnosticOptions()));
153 SourceManager SourceMgr(Diagnostics, Files);
154 Rewriter Rewrite(SourceMgr, LangOptions());
155 llvm::MemoryBuffer *Buf = llvm::MemoryBuffer::getMemBuffer(Code, "<stdin>");
156 const clang::FileEntry *Entry =
157 Files.getVirtualFile("<stdin>", Buf->getBufferSize(), 0);
158 SourceMgr.overrideFileContents(Entry, Buf);
159 FileID ID =
160 SourceMgr.createFileID(Entry, SourceLocation(), clang::SrcMgr::C_User);
David Blaikie76a2ea32013-07-17 18:29:58 +0000161 for (Replacements::const_iterator I = Replaces.begin(), E = Replaces.end();
162 I != E; ++I) {
Daniel Jasper8a999452013-05-16 10:40:07 +0000163 Replacement Replace("<stdin>", I->getOffset(), I->getLength(),
164 I->getReplacementText());
165 if (!Replace.apply(Rewrite))
166 return "";
167 }
168 std::string Result;
169 llvm::raw_string_ostream OS(Result);
170 Rewrite.getEditBuffer(ID).write(OS);
171 OS.flush();
172 return Result;
173}
174
Daniel Jasper6bd3b932013-05-21 12:21:39 +0000175unsigned shiftedCodePosition(const Replacements &Replaces, unsigned Position) {
176 unsigned NewPosition = Position;
177 for (Replacements::iterator I = Replaces.begin(), E = Replaces.end(); I != E;
178 ++I) {
179 if (I->getOffset() >= Position)
180 break;
181 if (I->getOffset() + I->getLength() > Position)
182 NewPosition += I->getOffset() + I->getLength() - Position;
183 NewPosition += I->getReplacementText().size() - I->getLength();
184 }
185 return NewPosition;
186}
187
Edwin Vaned5692db2013-08-08 13:31:14 +0000188void deduplicate(std::vector<Replacement> &Replaces,
189 std::vector<Range> &Conflicts) {
190 if (Replaces.empty())
191 return;
192
193 // Deduplicate
194 std::sort(Replaces.begin(), Replaces.end(), Replacement::Less());
195 std::vector<Replacement>::iterator End =
196 std::unique(Replaces.begin(), Replaces.end());
197 Replaces.erase(End, Replaces.end());
198
199 // Detect conflicts
200 Range ConflictRange(Replaces.front().getOffset(),
201 Replaces.front().getLength());
202 unsigned ConflictStart = 0;
203 unsigned ConflictLength = 1;
204 for (unsigned i = 1; i < Replaces.size(); ++i) {
205 Range Current(Replaces[i].getOffset(), Replaces[i].getLength());
206 if (ConflictRange.overlapsWith(Current)) {
207 // Extend conflicted range
208 ConflictRange = Range(ConflictRange.getOffset(),
209 Current.getOffset() + Current.getLength() -
210 ConflictRange.getOffset());
211 ++ConflictLength;
212 } else {
213 if (ConflictLength > 1)
214 Conflicts.push_back(Range(ConflictStart, ConflictLength));
215 ConflictRange = Current;
216 ConflictStart = i;
217 ConflictLength = 1;
218 }
219 }
220
221 if (ConflictLength > 1)
222 Conflicts.push_back(Range(ConflictStart, ConflictLength));
223}
224
225
Edwin Vaned088a5f2013-01-11 17:04:55 +0000226RefactoringTool::RefactoringTool(const CompilationDatabase &Compilations,
227 ArrayRef<std::string> SourcePaths)
228 : ClangTool(Compilations, SourcePaths) {}
229
230Replacements &RefactoringTool::getReplacements() { return Replace; }
231
232int RefactoringTool::runAndSave(FrontendActionFactory *ActionFactory) {
233 if (int Result = run(ActionFactory)) {
234 return Result;
235 }
236
237 LangOptions DefaultLangOptions;
238 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions();
239 TextDiagnosticPrinter DiagnosticPrinter(llvm::errs(), &*DiagOpts);
240 DiagnosticsEngine Diagnostics(
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000241 IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs()),
Edwin Vaned088a5f2013-01-11 17:04:55 +0000242 &*DiagOpts, &DiagnosticPrinter, false);
243 SourceManager Sources(Diagnostics, getFiles());
244 Rewriter Rewrite(Sources, DefaultLangOptions);
245
246 if (!applyAllReplacements(Rewrite)) {
247 llvm::errs() << "Skipped some replacements.\n";
248 }
249
250 return saveRewrittenFiles(Rewrite);
251}
252
253bool RefactoringTool::applyAllReplacements(Rewriter &Rewrite) {
254 return tooling::applyAllReplacements(Replace, Rewrite);
255}
256
257int RefactoringTool::saveRewrittenFiles(Rewriter &Rewrite) {
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +0000258 for (Rewriter::buffer_iterator I = Rewrite.buffer_begin(),
259 E = Rewrite.buffer_end();
260 I != E; ++I) {
261 // FIXME: This code is copied from the FixItRewriter.cpp - I think it should
262 // go into directly into Rewriter (there we also have the Diagnostics to
263 // handle the error cases better).
264 const FileEntry *Entry =
265 Rewrite.getSourceMgr().getFileEntryForID(I->first);
266 std::string ErrorInfo;
Rafael Espindolad965f952013-07-16 19:44:23 +0000267 llvm::raw_fd_ostream FileStream(Entry->getName(), ErrorInfo,
268 llvm::sys::fs::F_Binary);
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +0000269 if (!ErrorInfo.empty())
Edwin Vaned088a5f2013-01-11 17:04:55 +0000270 return 1;
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +0000271 I->second.write(FileStream);
272 FileStream.flush();
273 }
Edwin Vaned088a5f2013-01-11 17:04:55 +0000274 return 0;
Manuel Klimekf9d4cbd2012-05-23 16:29:20 +0000275}
276
277} // end namespace tooling
278} // end namespace clang