blob: 72f35205ca8e92d4fa70466d112f62a71b277e13 [file] [log] [blame]
John McCalld70fb982011-06-15 23:25:17 +00001//===--- ARCMT.cpp - Migration to ARC mode --------------------------------===//
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#include "Internals.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000011#include "clang/AST/ASTConsumer.h"
12#include "clang/Basic/DiagnosticCategories.h"
John McCalld70fb982011-06-15 23:25:17 +000013#include "clang/Frontend/ASTUnit.h"
14#include "clang/Frontend/CompilerInstance.h"
Douglas Gregor32fbe312012-01-20 16:28:04 +000015#include "clang/Frontend/FrontendAction.h"
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +000016#include "clang/Frontend/TextDiagnosticPrinter.h"
John McCalld70fb982011-06-15 23:25:17 +000017#include "clang/Frontend/Utils.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000018#include "clang/Lex/Preprocessor.h"
Ted Kremenekcdf81492012-09-01 05:09:24 +000019#include "clang/Rewrite/Core/Rewriter.h"
John McCalld70fb982011-06-15 23:25:17 +000020#include "clang/Sema/SemaDiagnostic.h"
Argyrios Kyrtzidis88c0d3b2013-02-05 16:37:00 +000021#include "clang/Serialization/ASTReader.h"
John McCalld70fb982011-06-15 23:25:17 +000022#include "llvm/ADT/Triple.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000023#include "llvm/Support/MemoryBuffer.h"
John McCalld70fb982011-06-15 23:25:17 +000024using namespace clang;
25using namespace arcmt;
John McCalld70fb982011-06-15 23:25:17 +000026
Chris Lattner54b16772011-07-23 17:14:25 +000027bool CapturedDiagList::clearDiagnostic(ArrayRef<unsigned> IDs,
John McCalld70fb982011-06-15 23:25:17 +000028 SourceRange range) {
29 if (range.isInvalid())
30 return false;
31
32 bool cleared = false;
33 ListTy::iterator I = List.begin();
34 while (I != List.end()) {
35 FullSourceLoc diagLoc = I->getLocation();
36 if ((IDs.empty() || // empty means clear all diagnostics in the range.
37 std::find(IDs.begin(), IDs.end(), I->getID()) != IDs.end()) &&
38 !diagLoc.isBeforeInTranslationUnitThan(range.getBegin()) &&
39 (diagLoc == range.getEnd() ||
40 diagLoc.isBeforeInTranslationUnitThan(range.getEnd()))) {
41 cleared = true;
42 ListTy::iterator eraseS = I++;
Argyrios Kyrtzidis03fbe3e2013-01-04 18:30:08 +000043 if (eraseS->getLevel() != DiagnosticsEngine::Note)
44 while (I != List.end() && I->getLevel() == DiagnosticsEngine::Note)
45 ++I;
John McCalld70fb982011-06-15 23:25:17 +000046 // Clear the diagnostic and any notes following it.
Joao Matos0e167f72012-08-31 17:28:09 +000047 I = List.erase(eraseS, I);
John McCalld70fb982011-06-15 23:25:17 +000048 continue;
49 }
50
51 ++I;
52 }
53
54 return cleared;
55}
56
Chris Lattner54b16772011-07-23 17:14:25 +000057bool CapturedDiagList::hasDiagnostic(ArrayRef<unsigned> IDs,
Argyrios Kyrtzidis0f3f9f72011-06-18 00:53:34 +000058 SourceRange range) const {
John McCalld70fb982011-06-15 23:25:17 +000059 if (range.isInvalid())
60 return false;
61
Argyrios Kyrtzidis0f3f9f72011-06-18 00:53:34 +000062 ListTy::const_iterator I = List.begin();
John McCalld70fb982011-06-15 23:25:17 +000063 while (I != List.end()) {
64 FullSourceLoc diagLoc = I->getLocation();
65 if ((IDs.empty() || // empty means any diagnostic in the range.
66 std::find(IDs.begin(), IDs.end(), I->getID()) != IDs.end()) &&
67 !diagLoc.isBeforeInTranslationUnitThan(range.getBegin()) &&
68 (diagLoc == range.getEnd() ||
69 diagLoc.isBeforeInTranslationUnitThan(range.getEnd()))) {
70 return true;
71 }
72
73 ++I;
74 }
75
76 return false;
77}
78
David Blaikie9c902b52011-09-25 23:23:43 +000079void CapturedDiagList::reportDiagnostics(DiagnosticsEngine &Diags) const {
Argyrios Kyrtzidis0f3f9f72011-06-18 00:53:34 +000080 for (ListTy::const_iterator I = List.begin(), E = List.end(); I != E; ++I)
John McCalld70fb982011-06-15 23:25:17 +000081 Diags.Report(*I);
82}
83
Argyrios Kyrtzidis90b6a2a2011-06-18 00:53:41 +000084bool CapturedDiagList::hasErrors() const {
85 for (ListTy::const_iterator I = List.begin(), E = List.end(); I != E; ++I)
David Blaikie9c902b52011-09-25 23:23:43 +000086 if (I->getLevel() >= DiagnosticsEngine::Error)
Argyrios Kyrtzidis90b6a2a2011-06-18 00:53:41 +000087 return true;
88
89 return false;
90}
91
John McCalld70fb982011-06-15 23:25:17 +000092namespace {
93
David Blaikiea24a0bc2011-09-25 23:54:33 +000094class CaptureDiagnosticConsumer : public DiagnosticConsumer {
David Blaikie9c902b52011-09-25 23:23:43 +000095 DiagnosticsEngine &Diags;
Jordan Roseb00073d2012-08-10 01:06:16 +000096 DiagnosticConsumer &DiagClient;
John McCalld70fb982011-06-15 23:25:17 +000097 CapturedDiagList &CapturedDiags;
Jordan Roseb00073d2012-08-10 01:06:16 +000098 bool HasBegunSourceFile;
John McCalld70fb982011-06-15 23:25:17 +000099public:
David Blaikiea24a0bc2011-09-25 23:54:33 +0000100 CaptureDiagnosticConsumer(DiagnosticsEngine &diags,
Jordan Roseb00073d2012-08-10 01:06:16 +0000101 DiagnosticConsumer &client,
102 CapturedDiagList &capturedDiags)
103 : Diags(diags), DiagClient(client), CapturedDiags(capturedDiags),
104 HasBegunSourceFile(false) { }
105
106 virtual void BeginSourceFile(const LangOptions &Opts,
107 const Preprocessor *PP) {
108 // Pass BeginSourceFile message onto DiagClient on first call.
109 // The corresponding EndSourceFile call will be made from an
110 // explicit call to FinishCapture.
111 if (!HasBegunSourceFile) {
112 DiagClient.BeginSourceFile(Opts, PP);
113 HasBegunSourceFile = true;
114 }
115 }
116
117 void FinishCapture() {
118 // Call EndSourceFile on DiagClient on completion of capture to
119 // enable VerifyDiagnosticConsumer to check diagnostics *after*
120 // it has received the diagnostic list.
121 if (HasBegunSourceFile) {
122 DiagClient.EndSourceFile();
123 HasBegunSourceFile = false;
124 }
125 }
126
127 virtual ~CaptureDiagnosticConsumer() {
128 assert(!HasBegunSourceFile && "FinishCapture not called!");
129 }
John McCalld70fb982011-06-15 23:25:17 +0000130
David Blaikie9c902b52011-09-25 23:23:43 +0000131 virtual void HandleDiagnostic(DiagnosticsEngine::Level level,
David Blaikieb5784322011-09-26 01:18:08 +0000132 const Diagnostic &Info) {
Ted Kremenek337c5b82011-10-20 05:07:47 +0000133 if (DiagnosticIDs::isARCDiagnostic(Info.getID()) ||
David Blaikie9c902b52011-09-25 23:23:43 +0000134 level >= DiagnosticsEngine::Error || level == DiagnosticsEngine::Note) {
Argyrios Kyrtzidis1f732162012-12-12 22:48:28 +0000135 if (Info.getLocation().isValid())
136 CapturedDiags.push_back(StoredDiagnostic(level, Info));
John McCalld70fb982011-06-15 23:25:17 +0000137 return;
138 }
139
140 // Non-ARC warnings are ignored.
141 Diags.setLastDiagnosticIgnored();
142 }
Douglas Gregord0e9e3a2011-09-29 00:38:00 +0000143
144 DiagnosticConsumer *clone(DiagnosticsEngine &Diags) const {
145 // Just drop any diagnostics that come from cloned consumers; they'll
146 // have different source managers anyway.
147 return new IgnoringDiagConsumer();
148 }
John McCalld70fb982011-06-15 23:25:17 +0000149};
150
151} // end anonymous namespace
152
Argyrios Kyrtzidis81a35902011-06-20 19:59:52 +0000153static bool HasARCRuntime(CompilerInvocation &origCI) {
154 // This duplicates some functionality from Darwin::AddDeploymentTarget
155 // but this function is well defined, so keep it decoupled from the driver
156 // and avoid unrelated complications.
Argyrios Kyrtzidis81a35902011-06-20 19:59:52 +0000157 llvm::Triple triple(origCI.getTargetOpts().Triple);
158
159 if (triple.getOS() == llvm::Triple::IOS)
160 return triple.getOSMajorVersion() >= 5;
161
162 if (triple.getOS() == llvm::Triple::Darwin)
163 return triple.getOSMajorVersion() >= 11;
164
165 if (triple.getOS() == llvm::Triple::MacOSX) {
166 unsigned Major, Minor, Micro;
167 triple.getOSVersion(Major, Minor, Micro);
168 return Major > 10 || (Major == 10 && Minor >= 7);
169 }
170
171 return false;
172}
173
Benjamin Kramer3c05b7c2011-08-02 04:50:49 +0000174static CompilerInvocation *
175createInvocationForMigration(CompilerInvocation &origCI) {
Dylan Noblesmithe2778992012-02-05 02:12:40 +0000176 OwningPtr<CompilerInvocation> CInvok;
John McCalld70fb982011-06-15 23:25:17 +0000177 CInvok.reset(new CompilerInvocation(origCI));
Argyrios Kyrtzidis88c0d3b2013-02-05 16:37:00 +0000178 PreprocessorOptions &PPOpts = CInvok->getPreprocessorOpts();
179 if (!PPOpts.ImplicitPCHInclude.empty()) {
180 // We can't use a PCH because it was likely built in non-ARC mode and we
181 // want to parse in ARC. Include the original header.
182 FileManager FileMgr(origCI.getFileSystemOpts());
183 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
184 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
185 new DiagnosticsEngine(DiagID, &origCI.getDiagnosticOpts(),
186 new IgnoringDiagConsumer()));
187 std::string OriginalFile =
188 ASTReader::getOriginalSourceFile(PPOpts.ImplicitPCHInclude,
189 FileMgr, *Diags);
190 if (!OriginalFile.empty())
191 PPOpts.Includes.insert(PPOpts.Includes.begin(), OriginalFile);
192 PPOpts.ImplicitPCHInclude.clear();
193 }
194 // FIXME: Get the original header of a PTH as well.
195 CInvok->getPreprocessorOpts().ImplicitPTHInclude.clear();
John McCalld70fb982011-06-15 23:25:17 +0000196 std::string define = getARCMTMacroName();
197 define += '=';
198 CInvok->getPreprocessorOpts().addMacroDef(define);
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000199 CInvok->getLangOpts()->ObjCAutoRefCount = true;
200 CInvok->getLangOpts()->setGC(LangOptions::NonGC);
John McCalld70fb982011-06-15 23:25:17 +0000201 CInvok->getDiagnosticOpts().ErrorLimit = 0;
Argyrios Kyrtzidisaa38f692012-06-20 01:46:26 +0000202 CInvok->getDiagnosticOpts().PedanticErrors = 0;
Argyrios Kyrtzidis692bf8c2012-06-20 01:10:40 +0000203
204 // Ignore -Werror flags when migrating.
205 std::vector<std::string> WarnOpts;
206 for (std::vector<std::string>::iterator
207 I = CInvok->getDiagnosticOpts().Warnings.begin(),
208 E = CInvok->getDiagnosticOpts().Warnings.end(); I != E; ++I) {
209 if (!StringRef(*I).startswith("error"))
210 WarnOpts.push_back(*I);
211 }
212 WarnOpts.push_back("error=arc-unsafe-retained-assign");
Argyrios Kyrtzidisaa38f692012-06-20 01:46:26 +0000213 CInvok->getDiagnosticOpts().Warnings = llvm_move(WarnOpts);
Argyrios Kyrtzidis692bf8c2012-06-20 01:10:40 +0000214
John McCall3deb1ad2012-08-21 02:47:43 +0000215 CInvok->getLangOpts()->ObjCARCWeak = HasARCRuntime(origCI);
John McCalld70fb982011-06-15 23:25:17 +0000216
217 return CInvok.take();
218}
219
Benjamin Kramer3c05b7c2011-08-02 04:50:49 +0000220static void emitPremigrationErrors(const CapturedDiagList &arcDiags,
Douglas Gregor811db4e2012-10-23 22:26:28 +0000221 DiagnosticOptions *diagOpts,
Benjamin Kramer3c05b7c2011-08-02 04:50:49 +0000222 Preprocessor &PP) {
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000223 TextDiagnosticPrinter printer(llvm::errs(), diagOpts);
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000224 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
225 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000226 new DiagnosticsEngine(DiagID, diagOpts, &printer,
227 /*ShouldOwnClient=*/false));
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000228 Diags->setSourceManager(&PP.getSourceManager());
229
David Blaikiebbafb8a2012-03-11 07:00:24 +0000230 printer.BeginSourceFile(PP.getLangOpts(), &PP);
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000231 arcDiags.reportDiagnostics(*Diags);
232 printer.EndSourceFile();
233}
234
John McCalld70fb982011-06-15 23:25:17 +0000235//===----------------------------------------------------------------------===//
236// checkForManualIssues.
237//===----------------------------------------------------------------------===//
238
239bool arcmt::checkForManualIssues(CompilerInvocation &origCI,
Douglas Gregor32fbe312012-01-20 16:28:04 +0000240 const FrontendInputFile &Input,
David Blaikiee2eefae2011-09-25 23:39:51 +0000241 DiagnosticConsumer *DiagClient,
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000242 bool emitPremigrationARCErrors,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000243 StringRef plistOut) {
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000244 if (!origCI.getLangOpts()->ObjC1)
John McCalld70fb982011-06-15 23:25:17 +0000245 return false;
246
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000247 LangOptions::GCMode OrigGCMode = origCI.getLangOpts()->getGC();
Fariborz Jahanianaa7b9aa2012-01-25 00:20:29 +0000248 bool NoNSAllocReallocError = origCI.getMigratorOpts().NoNSAllocReallocError;
Fariborz Jahanian0c859d62012-01-26 00:08:04 +0000249 bool NoFinalizeRemoval = origCI.getMigratorOpts().NoFinalizeRemoval;
Argyrios Kyrtzidisd208ef92011-11-04 15:58:08 +0000250
Fariborz Jahanian48fd81b2012-01-26 20:57:58 +0000251 std::vector<TransformFn> transforms = arcmt::getAllTransformations(OrigGCMode,
252 NoFinalizeRemoval);
John McCalld70fb982011-06-15 23:25:17 +0000253 assert(!transforms.empty());
254
Dylan Noblesmithe2778992012-02-05 02:12:40 +0000255 OwningPtr<CompilerInvocation> CInvok;
John McCalld70fb982011-06-15 23:25:17 +0000256 CInvok.reset(createInvocationForMigration(origCI));
257 CInvok->getFrontendOpts().Inputs.clear();
Douglas Gregor32fbe312012-01-20 16:28:04 +0000258 CInvok->getFrontendOpts().Inputs.push_back(Input);
John McCalld70fb982011-06-15 23:25:17 +0000259
260 CapturedDiagList capturedDiags;
261
262 assert(DiagClient);
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000263 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
264 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000265 new DiagnosticsEngine(DiagID, &origCI.getDiagnosticOpts(),
266 DiagClient, /*ShouldOwnClient=*/false));
John McCalld70fb982011-06-15 23:25:17 +0000267
268 // Filter of all diagnostics.
Jordan Roseb00073d2012-08-10 01:06:16 +0000269 CaptureDiagnosticConsumer errRec(*Diags, *DiagClient, capturedDiags);
John McCalld70fb982011-06-15 23:25:17 +0000270 Diags->setClient(&errRec, /*ShouldOwnClient=*/false);
271
Dylan Noblesmithe2778992012-02-05 02:12:40 +0000272 OwningPtr<ASTUnit> Unit(
John McCalld70fb982011-06-15 23:25:17 +0000273 ASTUnit::LoadFromCompilerInvocationAction(CInvok.take(), Diags));
Jordan Roseb00073d2012-08-10 01:06:16 +0000274 if (!Unit) {
275 errRec.FinishCapture();
John McCalld70fb982011-06-15 23:25:17 +0000276 return true;
Jordan Roseb00073d2012-08-10 01:06:16 +0000277 }
John McCalld70fb982011-06-15 23:25:17 +0000278
279 // Don't filter diagnostics anymore.
280 Diags->setClient(DiagClient, /*ShouldOwnClient=*/false);
281
282 ASTContext &Ctx = Unit->getASTContext();
283
284 if (Diags->hasFatalErrorOccurred()) {
285 Diags->Reset();
David Blaikiebbafb8a2012-03-11 07:00:24 +0000286 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
John McCalld70fb982011-06-15 23:25:17 +0000287 capturedDiags.reportDiagnostics(*Diags);
288 DiagClient->EndSourceFile();
Jordan Roseb00073d2012-08-10 01:06:16 +0000289 errRec.FinishCapture();
John McCalld70fb982011-06-15 23:25:17 +0000290 return true;
291 }
292
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000293 if (emitPremigrationARCErrors)
Douglas Gregor811db4e2012-10-23 22:26:28 +0000294 emitPremigrationErrors(capturedDiags, &origCI.getDiagnosticOpts(),
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000295 Unit->getPreprocessor());
296 if (!plistOut.empty()) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000297 SmallVector<StoredDiagnostic, 8> arcDiags;
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000298 for (CapturedDiagList::iterator
299 I = capturedDiags.begin(), E = capturedDiags.end(); I != E; ++I)
300 arcDiags.push_back(*I);
301 writeARCDiagsToPlist(plistOut, arcDiags,
David Blaikiebbafb8a2012-03-11 07:00:24 +0000302 Ctx.getSourceManager(), Ctx.getLangOpts());
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000303 }
304
John McCalld70fb982011-06-15 23:25:17 +0000305 // After parsing of source files ended, we want to reuse the
306 // diagnostics objects to emit further diagnostics.
David Blaikiee2eefae2011-09-25 23:39:51 +0000307 // We call BeginSourceFile because DiagnosticConsumer requires that
John McCalld70fb982011-06-15 23:25:17 +0000308 // diagnostics with source range information are emitted only in between
309 // BeginSourceFile() and EndSourceFile().
David Blaikiebbafb8a2012-03-11 07:00:24 +0000310 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
John McCalld70fb982011-06-15 23:25:17 +0000311
312 // No macros will be added since we are just checking and we won't modify
313 // source code.
314 std::vector<SourceLocation> ARCMTMacroLocs;
315
316 TransformActions testAct(*Diags, capturedDiags, Ctx, Unit->getPreprocessor());
Argyrios Kyrtzidis03fbe3e2013-01-04 18:30:08 +0000317 MigrationPass pass(Ctx, OrigGCMode, Unit->getSema(), testAct, capturedDiags,
318 ARCMTMacroLocs);
Fariborz Jahanianaa7b9aa2012-01-25 00:20:29 +0000319 pass.setNSAllocReallocError(NoNSAllocReallocError);
Fariborz Jahanian0c859d62012-01-26 00:08:04 +0000320 pass.setNoFinalizeRemoval(NoFinalizeRemoval);
John McCalld70fb982011-06-15 23:25:17 +0000321
322 for (unsigned i=0, e = transforms.size(); i != e; ++i)
323 transforms[i](pass);
324
325 capturedDiags.reportDiagnostics(*Diags);
326
327 DiagClient->EndSourceFile();
Jordan Roseb00073d2012-08-10 01:06:16 +0000328 errRec.FinishCapture();
John McCalld70fb982011-06-15 23:25:17 +0000329
Argyrios Kyrtzidise2e40b42011-07-14 00:17:54 +0000330 // If we are migrating code that gets the '-fobjc-arc' flag, make sure
331 // to remove it so that we don't get errors from normal compilation.
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000332 origCI.getLangOpts()->ObjCAutoRefCount = false;
Argyrios Kyrtzidise2e40b42011-07-14 00:17:54 +0000333
Argyrios Kyrtzidis73a0d322011-07-18 07:44:45 +0000334 return capturedDiags.hasErrors() || testAct.hasReportedErrors();
John McCalld70fb982011-06-15 23:25:17 +0000335}
336
337//===----------------------------------------------------------------------===//
338// applyTransformations.
339//===----------------------------------------------------------------------===//
340
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000341static bool applyTransforms(CompilerInvocation &origCI,
Douglas Gregor32fbe312012-01-20 16:28:04 +0000342 const FrontendInputFile &Input,
David Blaikiee2eefae2011-09-25 23:39:51 +0000343 DiagnosticConsumer *DiagClient,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000344 StringRef outputDir,
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000345 bool emitPremigrationARCErrors,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000346 StringRef plistOut) {
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000347 if (!origCI.getLangOpts()->ObjC1)
John McCalld70fb982011-06-15 23:25:17 +0000348 return false;
349
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000350 LangOptions::GCMode OrigGCMode = origCI.getLangOpts()->getGC();
Argyrios Kyrtzidisd208ef92011-11-04 15:58:08 +0000351
John McCalld70fb982011-06-15 23:25:17 +0000352 // Make sure checking is successful first.
353 CompilerInvocation CInvokForCheck(origCI);
Douglas Gregor32fbe312012-01-20 16:28:04 +0000354 if (arcmt::checkForManualIssues(CInvokForCheck, Input, DiagClient,
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000355 emitPremigrationARCErrors, plistOut))
John McCalld70fb982011-06-15 23:25:17 +0000356 return true;
357
358 CompilerInvocation CInvok(origCI);
359 CInvok.getFrontendOpts().Inputs.clear();
Douglas Gregor32fbe312012-01-20 16:28:04 +0000360 CInvok.getFrontendOpts().Inputs.push_back(Input);
John McCalld70fb982011-06-15 23:25:17 +0000361
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000362 MigrationProcess migration(CInvok, DiagClient, outputDir);
Fariborz Jahanian48fd81b2012-01-26 20:57:58 +0000363 bool NoFinalizeRemoval = origCI.getMigratorOpts().NoFinalizeRemoval;
John McCalld70fb982011-06-15 23:25:17 +0000364
Fariborz Jahanian48fd81b2012-01-26 20:57:58 +0000365 std::vector<TransformFn> transforms = arcmt::getAllTransformations(OrigGCMode,
366 NoFinalizeRemoval);
John McCalld70fb982011-06-15 23:25:17 +0000367 assert(!transforms.empty());
368
369 for (unsigned i=0, e = transforms.size(); i != e; ++i) {
370 bool err = migration.applyTransform(transforms[i]);
371 if (err) return true;
372 }
373
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000374 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
375 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000376 new DiagnosticsEngine(DiagID, &origCI.getDiagnosticOpts(),
377 DiagClient, /*ShouldOwnClient=*/false));
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000378
379 if (outputDir.empty()) {
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000380 origCI.getLangOpts()->ObjCAutoRefCount = true;
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000381 return migration.getRemapper().overwriteOriginal(*Diags);
Argyrios Kyrtzidise2e40b42011-07-14 00:17:54 +0000382 } else {
383 // If we are migrating code that gets the '-fobjc-arc' flag, make sure
384 // to remove it so that we don't get errors from normal compilation.
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000385 origCI.getLangOpts()->ObjCAutoRefCount = false;
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000386 return migration.getRemapper().flushToDisk(outputDir, *Diags);
Argyrios Kyrtzidise2e40b42011-07-14 00:17:54 +0000387 }
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000388}
389
390bool arcmt::applyTransformations(CompilerInvocation &origCI,
Douglas Gregor32fbe312012-01-20 16:28:04 +0000391 const FrontendInputFile &Input,
David Blaikiee2eefae2011-09-25 23:39:51 +0000392 DiagnosticConsumer *DiagClient) {
Douglas Gregor32fbe312012-01-20 16:28:04 +0000393 return applyTransforms(origCI, Input, DiagClient,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000394 StringRef(), false, StringRef());
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000395}
396
397bool arcmt::migrateWithTemporaryFiles(CompilerInvocation &origCI,
Douglas Gregor32fbe312012-01-20 16:28:04 +0000398 const FrontendInputFile &Input,
David Blaikiee2eefae2011-09-25 23:39:51 +0000399 DiagnosticConsumer *DiagClient,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000400 StringRef outputDir,
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000401 bool emitPremigrationARCErrors,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000402 StringRef plistOut) {
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000403 assert(!outputDir.empty() && "Expected output directory path");
Douglas Gregor32fbe312012-01-20 16:28:04 +0000404 return applyTransforms(origCI, Input, DiagClient,
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000405 outputDir, emitPremigrationARCErrors, plistOut);
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000406}
407
408bool arcmt::getFileRemappings(std::vector<std::pair<std::string,std::string> > &
409 remap,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000410 StringRef outputDir,
David Blaikiee2eefae2011-09-25 23:39:51 +0000411 DiagnosticConsumer *DiagClient) {
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000412 assert(!outputDir.empty());
John McCalld70fb982011-06-15 23:25:17 +0000413
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000414 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
415 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000416 new DiagnosticsEngine(DiagID, new DiagnosticOptions,
417 DiagClient, /*ShouldOwnClient=*/false));
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000418
419 FileRemapper remapper;
420 bool err = remapper.initFromDisk(outputDir, *Diags,
421 /*ignoreIfFilesChanged=*/true);
422 if (err)
423 return true;
424
Ted Kremenekf7639e12012-03-06 20:06:33 +0000425 PreprocessorOptions PPOpts;
426 remapper.applyMappings(PPOpts);
427 remap = PPOpts.RemappedFiles;
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000428
429 return false;
John McCalld70fb982011-06-15 23:25:17 +0000430}
431
Ted Kremenekf7639e12012-03-06 20:06:33 +0000432bool arcmt::getFileRemappingsFromFileList(
433 std::vector<std::pair<std::string,std::string> > &remap,
434 ArrayRef<StringRef> remapFiles,
435 DiagnosticConsumer *DiagClient) {
436 bool hasErrorOccurred = false;
437 llvm::StringMap<bool> Uniquer;
438
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000439 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
440 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000441 new DiagnosticsEngine(DiagID, new DiagnosticOptions,
442 DiagClient, /*ShouldOwnClient=*/false));
Ted Kremenekf7639e12012-03-06 20:06:33 +0000443
444 for (ArrayRef<StringRef>::iterator
445 I = remapFiles.begin(), E = remapFiles.end(); I != E; ++I) {
446 StringRef file = *I;
447
448 FileRemapper remapper;
449 bool err = remapper.initFromFile(file, *Diags,
450 /*ignoreIfFilesChanged=*/true);
451 hasErrorOccurred = hasErrorOccurred || err;
452 if (err)
453 continue;
454
455 PreprocessorOptions PPOpts;
456 remapper.applyMappings(PPOpts);
457 for (PreprocessorOptions::remapped_file_iterator
458 RI = PPOpts.remapped_file_begin(), RE = PPOpts.remapped_file_end();
459 RI != RE; ++RI) {
460 bool &inserted = Uniquer[RI->first];
461 if (inserted)
462 continue;
463 inserted = true;
464 remap.push_back(*RI);
465 }
466 }
467
468 return hasErrorOccurred;
469}
470
John McCalld70fb982011-06-15 23:25:17 +0000471//===----------------------------------------------------------------------===//
John McCalld70fb982011-06-15 23:25:17 +0000472// CollectTransformActions.
473//===----------------------------------------------------------------------===//
474
475namespace {
476
477class ARCMTMacroTrackerPPCallbacks : public PPCallbacks {
478 std::vector<SourceLocation> &ARCMTMacroLocs;
479
480public:
481 ARCMTMacroTrackerPPCallbacks(std::vector<SourceLocation> &ARCMTMacroLocs)
482 : ARCMTMacroLocs(ARCMTMacroLocs) { }
483
Argyrios Kyrtzidisfead64b2013-02-24 00:05:14 +0000484 virtual void MacroExpands(const Token &MacroNameTok, const MacroDirective *MD,
Argyrios Kyrtzidis85a14bb2011-08-18 01:05:45 +0000485 SourceRange Range) {
John McCalld70fb982011-06-15 23:25:17 +0000486 if (MacroNameTok.getIdentifierInfo()->getName() == getARCMTMacroName())
487 ARCMTMacroLocs.push_back(MacroNameTok.getLocation());
488 }
489};
490
491class ARCMTMacroTrackerAction : public ASTFrontendAction {
492 std::vector<SourceLocation> &ARCMTMacroLocs;
493
494public:
495 ARCMTMacroTrackerAction(std::vector<SourceLocation> &ARCMTMacroLocs)
496 : ARCMTMacroLocs(ARCMTMacroLocs) { }
497
498 virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000499 StringRef InFile) {
John McCalld70fb982011-06-15 23:25:17 +0000500 CI.getPreprocessor().addPPCallbacks(
501 new ARCMTMacroTrackerPPCallbacks(ARCMTMacroLocs));
502 return new ASTConsumer();
503 }
504};
505
506class RewritesApplicator : public TransformActions::RewriteReceiver {
507 Rewriter &rewriter;
John McCalld70fb982011-06-15 23:25:17 +0000508 MigrationProcess::RewriteListener *Listener;
509
510public:
511 RewritesApplicator(Rewriter &rewriter, ASTContext &ctx,
512 MigrationProcess::RewriteListener *listener)
Benjamin Kramerd1d76b22012-06-06 17:32:50 +0000513 : rewriter(rewriter), Listener(listener) {
John McCalld70fb982011-06-15 23:25:17 +0000514 if (Listener)
515 Listener->start(ctx);
516 }
517 ~RewritesApplicator() {
518 if (Listener)
519 Listener->finish();
520 }
521
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000522 virtual void insert(SourceLocation loc, StringRef text) {
John McCalld70fb982011-06-15 23:25:17 +0000523 bool err = rewriter.InsertText(loc, text, /*InsertAfter=*/true,
524 /*indentNewLines=*/true);
525 if (!err && Listener)
526 Listener->insert(loc, text);
527 }
528
529 virtual void remove(CharSourceRange range) {
530 Rewriter::RewriteOptions removeOpts;
531 removeOpts.IncludeInsertsAtBeginOfRange = false;
532 removeOpts.IncludeInsertsAtEndOfRange = false;
533 removeOpts.RemoveLineIfEmpty = true;
534
535 bool err = rewriter.RemoveText(range, removeOpts);
536 if (!err && Listener)
537 Listener->remove(range);
538 }
539
540 virtual void increaseIndentation(CharSourceRange range,
541 SourceLocation parentIndent) {
542 rewriter.IncreaseIndentation(range, parentIndent);
543 }
544};
545
546} // end anonymous namespace.
547
548/// \brief Anchor for VTable.
549MigrationProcess::RewriteListener::~RewriteListener() { }
550
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000551MigrationProcess::MigrationProcess(const CompilerInvocation &CI,
David Blaikiee2eefae2011-09-25 23:39:51 +0000552 DiagnosticConsumer *diagClient,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000553 StringRef outputDir)
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000554 : OrigCI(CI), DiagClient(diagClient) {
555 if (!outputDir.empty()) {
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000556 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
557 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000558 new DiagnosticsEngine(DiagID, &CI.getDiagnosticOpts(),
559 DiagClient, /*ShouldOwnClient=*/false));
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000560 Remapper.initFromDisk(outputDir, *Diags, /*ignoreIfFilesChanges=*/true);
561 }
562}
563
John McCalld70fb982011-06-15 23:25:17 +0000564bool MigrationProcess::applyTransform(TransformFn trans,
565 RewriteListener *listener) {
Dylan Noblesmithe2778992012-02-05 02:12:40 +0000566 OwningPtr<CompilerInvocation> CInvok;
John McCalld70fb982011-06-15 23:25:17 +0000567 CInvok.reset(createInvocationForMigration(OrigCI));
568 CInvok->getDiagnosticOpts().IgnoreWarnings = true;
569
Ted Kremenekf7639e12012-03-06 20:06:33 +0000570 Remapper.applyMappings(CInvok->getPreprocessorOpts());
John McCalld70fb982011-06-15 23:25:17 +0000571
572 CapturedDiagList capturedDiags;
573 std::vector<SourceLocation> ARCMTMacroLocs;
574
575 assert(DiagClient);
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000576 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
577 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000578 new DiagnosticsEngine(DiagID, new DiagnosticOptions,
579 DiagClient, /*ShouldOwnClient=*/false));
John McCalld70fb982011-06-15 23:25:17 +0000580
581 // Filter of all diagnostics.
Jordan Roseb00073d2012-08-10 01:06:16 +0000582 CaptureDiagnosticConsumer errRec(*Diags, *DiagClient, capturedDiags);
John McCalld70fb982011-06-15 23:25:17 +0000583 Diags->setClient(&errRec, /*ShouldOwnClient=*/false);
584
Dylan Noblesmithe2778992012-02-05 02:12:40 +0000585 OwningPtr<ARCMTMacroTrackerAction> ASTAction;
John McCalld70fb982011-06-15 23:25:17 +0000586 ASTAction.reset(new ARCMTMacroTrackerAction(ARCMTMacroLocs));
587
Dylan Noblesmithe2778992012-02-05 02:12:40 +0000588 OwningPtr<ASTUnit> Unit(
John McCalld70fb982011-06-15 23:25:17 +0000589 ASTUnit::LoadFromCompilerInvocationAction(CInvok.take(), Diags,
590 ASTAction.get()));
Jordan Roseb00073d2012-08-10 01:06:16 +0000591 if (!Unit) {
592 errRec.FinishCapture();
John McCalld70fb982011-06-15 23:25:17 +0000593 return true;
Jordan Roseb00073d2012-08-10 01:06:16 +0000594 }
John McCalld70fb982011-06-15 23:25:17 +0000595 Unit->setOwnsRemappedFileBuffers(false); // FileRemapper manages that.
596
597 // Don't filter diagnostics anymore.
598 Diags->setClient(DiagClient, /*ShouldOwnClient=*/false);
599
600 ASTContext &Ctx = Unit->getASTContext();
601
602 if (Diags->hasFatalErrorOccurred()) {
603 Diags->Reset();
David Blaikiebbafb8a2012-03-11 07:00:24 +0000604 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
John McCalld70fb982011-06-15 23:25:17 +0000605 capturedDiags.reportDiagnostics(*Diags);
606 DiagClient->EndSourceFile();
Jordan Roseb00073d2012-08-10 01:06:16 +0000607 errRec.FinishCapture();
John McCalld70fb982011-06-15 23:25:17 +0000608 return true;
609 }
610
611 // After parsing of source files ended, we want to reuse the
612 // diagnostics objects to emit further diagnostics.
David Blaikiee2eefae2011-09-25 23:39:51 +0000613 // We call BeginSourceFile because DiagnosticConsumer requires that
John McCalld70fb982011-06-15 23:25:17 +0000614 // diagnostics with source range information are emitted only in between
615 // BeginSourceFile() and EndSourceFile().
David Blaikiebbafb8a2012-03-11 07:00:24 +0000616 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
John McCalld70fb982011-06-15 23:25:17 +0000617
David Blaikiebbafb8a2012-03-11 07:00:24 +0000618 Rewriter rewriter(Ctx.getSourceManager(), Ctx.getLangOpts());
John McCalld70fb982011-06-15 23:25:17 +0000619 TransformActions TA(*Diags, capturedDiags, Ctx, Unit->getPreprocessor());
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000620 MigrationPass pass(Ctx, OrigCI.getLangOpts()->getGC(),
Argyrios Kyrtzidis03fbe3e2013-01-04 18:30:08 +0000621 Unit->getSema(), TA, capturedDiags, ARCMTMacroLocs);
John McCalld70fb982011-06-15 23:25:17 +0000622
623 trans(pass);
624
625 {
626 RewritesApplicator applicator(rewriter, Ctx, listener);
627 TA.applyRewrites(applicator);
628 }
629
630 DiagClient->EndSourceFile();
Jordan Roseb00073d2012-08-10 01:06:16 +0000631 errRec.FinishCapture();
John McCalld70fb982011-06-15 23:25:17 +0000632
633 if (DiagClient->getNumErrors())
634 return true;
635
636 for (Rewriter::buffer_iterator
637 I = rewriter.buffer_begin(), E = rewriter.buffer_end(); I != E; ++I) {
638 FileID FID = I->first;
639 RewriteBuffer &buf = I->second;
640 const FileEntry *file = Ctx.getSourceManager().getFileEntryForID(FID);
641 assert(file);
642 std::string newFname = file->getName();
643 newFname += "-trans";
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000644 SmallString<512> newText;
John McCalld70fb982011-06-15 23:25:17 +0000645 llvm::raw_svector_ostream vecOS(newText);
646 buf.write(vecOS);
647 vecOS.flush();
648 llvm::MemoryBuffer *memBuf = llvm::MemoryBuffer::getMemBufferCopy(
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000649 StringRef(newText.data(), newText.size()), newFname);
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000650 SmallString<64> filePath(file->getName());
John McCalld70fb982011-06-15 23:25:17 +0000651 Unit->getFileManager().FixupRelativePath(filePath);
652 Remapper.remap(filePath.str(), memBuf);
653 }
654
655 return false;
656}