blob: 6b1da08ce67be4d05f087d60dd8bb3857f518b1f [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"
John McCalld70fb982011-06-15 23:25:17 +000021#include "llvm/ADT/Triple.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000022#include "llvm/Support/MemoryBuffer.h"
John McCalld70fb982011-06-15 23:25:17 +000023using namespace clang;
24using namespace arcmt;
John McCalld70fb982011-06-15 23:25:17 +000025
Chris Lattner54b16772011-07-23 17:14:25 +000026bool CapturedDiagList::clearDiagnostic(ArrayRef<unsigned> IDs,
John McCalld70fb982011-06-15 23:25:17 +000027 SourceRange range) {
28 if (range.isInvalid())
29 return false;
30
31 bool cleared = false;
32 ListTy::iterator I = List.begin();
33 while (I != List.end()) {
34 FullSourceLoc diagLoc = I->getLocation();
35 if ((IDs.empty() || // empty means clear all diagnostics in the range.
36 std::find(IDs.begin(), IDs.end(), I->getID()) != IDs.end()) &&
37 !diagLoc.isBeforeInTranslationUnitThan(range.getBegin()) &&
38 (diagLoc == range.getEnd() ||
39 diagLoc.isBeforeInTranslationUnitThan(range.getEnd()))) {
40 cleared = true;
41 ListTy::iterator eraseS = I++;
David Blaikie9c902b52011-09-25 23:23:43 +000042 while (I != List.end() && I->getLevel() == DiagnosticsEngine::Note)
John McCalld70fb982011-06-15 23:25:17 +000043 ++I;
44 // Clear the diagnostic and any notes following it.
Joao Matos0e167f72012-08-31 17:28:09 +000045 I = List.erase(eraseS, I);
John McCalld70fb982011-06-15 23:25:17 +000046 continue;
47 }
48
49 ++I;
50 }
51
52 return cleared;
53}
54
Chris Lattner54b16772011-07-23 17:14:25 +000055bool CapturedDiagList::hasDiagnostic(ArrayRef<unsigned> IDs,
Argyrios Kyrtzidis0f3f9f72011-06-18 00:53:34 +000056 SourceRange range) const {
John McCalld70fb982011-06-15 23:25:17 +000057 if (range.isInvalid())
58 return false;
59
Argyrios Kyrtzidis0f3f9f72011-06-18 00:53:34 +000060 ListTy::const_iterator I = List.begin();
John McCalld70fb982011-06-15 23:25:17 +000061 while (I != List.end()) {
62 FullSourceLoc diagLoc = I->getLocation();
63 if ((IDs.empty() || // empty means any diagnostic in the range.
64 std::find(IDs.begin(), IDs.end(), I->getID()) != IDs.end()) &&
65 !diagLoc.isBeforeInTranslationUnitThan(range.getBegin()) &&
66 (diagLoc == range.getEnd() ||
67 diagLoc.isBeforeInTranslationUnitThan(range.getEnd()))) {
68 return true;
69 }
70
71 ++I;
72 }
73
74 return false;
75}
76
David Blaikie9c902b52011-09-25 23:23:43 +000077void CapturedDiagList::reportDiagnostics(DiagnosticsEngine &Diags) const {
Argyrios Kyrtzidis0f3f9f72011-06-18 00:53:34 +000078 for (ListTy::const_iterator I = List.begin(), E = List.end(); I != E; ++I)
John McCalld70fb982011-06-15 23:25:17 +000079 Diags.Report(*I);
80}
81
Argyrios Kyrtzidis90b6a2a2011-06-18 00:53:41 +000082bool CapturedDiagList::hasErrors() const {
83 for (ListTy::const_iterator I = List.begin(), E = List.end(); I != E; ++I)
David Blaikie9c902b52011-09-25 23:23:43 +000084 if (I->getLevel() >= DiagnosticsEngine::Error)
Argyrios Kyrtzidis90b6a2a2011-06-18 00:53:41 +000085 return true;
86
87 return false;
88}
89
John McCalld70fb982011-06-15 23:25:17 +000090namespace {
91
David Blaikiea24a0bc2011-09-25 23:54:33 +000092class CaptureDiagnosticConsumer : public DiagnosticConsumer {
David Blaikie9c902b52011-09-25 23:23:43 +000093 DiagnosticsEngine &Diags;
Jordan Roseb00073d2012-08-10 01:06:16 +000094 DiagnosticConsumer &DiagClient;
John McCalld70fb982011-06-15 23:25:17 +000095 CapturedDiagList &CapturedDiags;
Jordan Roseb00073d2012-08-10 01:06:16 +000096 bool HasBegunSourceFile;
John McCalld70fb982011-06-15 23:25:17 +000097public:
David Blaikiea24a0bc2011-09-25 23:54:33 +000098 CaptureDiagnosticConsumer(DiagnosticsEngine &diags,
Jordan Roseb00073d2012-08-10 01:06:16 +000099 DiagnosticConsumer &client,
100 CapturedDiagList &capturedDiags)
101 : Diags(diags), DiagClient(client), CapturedDiags(capturedDiags),
102 HasBegunSourceFile(false) { }
103
104 virtual void BeginSourceFile(const LangOptions &Opts,
105 const Preprocessor *PP) {
106 // Pass BeginSourceFile message onto DiagClient on first call.
107 // The corresponding EndSourceFile call will be made from an
108 // explicit call to FinishCapture.
109 if (!HasBegunSourceFile) {
110 DiagClient.BeginSourceFile(Opts, PP);
111 HasBegunSourceFile = true;
112 }
113 }
114
115 void FinishCapture() {
116 // Call EndSourceFile on DiagClient on completion of capture to
117 // enable VerifyDiagnosticConsumer to check diagnostics *after*
118 // it has received the diagnostic list.
119 if (HasBegunSourceFile) {
120 DiagClient.EndSourceFile();
121 HasBegunSourceFile = false;
122 }
123 }
124
125 virtual ~CaptureDiagnosticConsumer() {
126 assert(!HasBegunSourceFile && "FinishCapture not called!");
127 }
John McCalld70fb982011-06-15 23:25:17 +0000128
David Blaikie9c902b52011-09-25 23:23:43 +0000129 virtual void HandleDiagnostic(DiagnosticsEngine::Level level,
David Blaikieb5784322011-09-26 01:18:08 +0000130 const Diagnostic &Info) {
Ted Kremenek337c5b82011-10-20 05:07:47 +0000131 if (DiagnosticIDs::isARCDiagnostic(Info.getID()) ||
David Blaikie9c902b52011-09-25 23:23:43 +0000132 level >= DiagnosticsEngine::Error || level == DiagnosticsEngine::Note) {
Argyrios Kyrtzidis1f732162012-12-12 22:48:28 +0000133 if (Info.getLocation().isValid())
134 CapturedDiags.push_back(StoredDiagnostic(level, Info));
John McCalld70fb982011-06-15 23:25:17 +0000135 return;
136 }
137
138 // Non-ARC warnings are ignored.
139 Diags.setLastDiagnosticIgnored();
140 }
Douglas Gregord0e9e3a2011-09-29 00:38:00 +0000141
142 DiagnosticConsumer *clone(DiagnosticsEngine &Diags) const {
143 // Just drop any diagnostics that come from cloned consumers; they'll
144 // have different source managers anyway.
145 return new IgnoringDiagConsumer();
146 }
John McCalld70fb982011-06-15 23:25:17 +0000147};
148
149} // end anonymous namespace
150
Argyrios Kyrtzidis81a35902011-06-20 19:59:52 +0000151static bool HasARCRuntime(CompilerInvocation &origCI) {
152 // This duplicates some functionality from Darwin::AddDeploymentTarget
153 // but this function is well defined, so keep it decoupled from the driver
154 // and avoid unrelated complications.
Argyrios Kyrtzidis81a35902011-06-20 19:59:52 +0000155 llvm::Triple triple(origCI.getTargetOpts().Triple);
156
157 if (triple.getOS() == llvm::Triple::IOS)
158 return triple.getOSMajorVersion() >= 5;
159
160 if (triple.getOS() == llvm::Triple::Darwin)
161 return triple.getOSMajorVersion() >= 11;
162
163 if (triple.getOS() == llvm::Triple::MacOSX) {
164 unsigned Major, Minor, Micro;
165 triple.getOSVersion(Major, Minor, Micro);
166 return Major > 10 || (Major == 10 && Minor >= 7);
167 }
168
169 return false;
170}
171
Benjamin Kramer3c05b7c2011-08-02 04:50:49 +0000172static CompilerInvocation *
173createInvocationForMigration(CompilerInvocation &origCI) {
Dylan Noblesmithe2778992012-02-05 02:12:40 +0000174 OwningPtr<CompilerInvocation> CInvok;
John McCalld70fb982011-06-15 23:25:17 +0000175 CInvok.reset(new CompilerInvocation(origCI));
176 CInvok->getPreprocessorOpts().ImplicitPCHInclude = std::string();
177 CInvok->getPreprocessorOpts().ImplicitPTHInclude = std::string();
178 std::string define = getARCMTMacroName();
179 define += '=';
180 CInvok->getPreprocessorOpts().addMacroDef(define);
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000181 CInvok->getLangOpts()->ObjCAutoRefCount = true;
182 CInvok->getLangOpts()->setGC(LangOptions::NonGC);
John McCalld70fb982011-06-15 23:25:17 +0000183 CInvok->getDiagnosticOpts().ErrorLimit = 0;
Argyrios Kyrtzidisaa38f692012-06-20 01:46:26 +0000184 CInvok->getDiagnosticOpts().PedanticErrors = 0;
Argyrios Kyrtzidis692bf8c2012-06-20 01:10:40 +0000185
186 // Ignore -Werror flags when migrating.
187 std::vector<std::string> WarnOpts;
188 for (std::vector<std::string>::iterator
189 I = CInvok->getDiagnosticOpts().Warnings.begin(),
190 E = CInvok->getDiagnosticOpts().Warnings.end(); I != E; ++I) {
191 if (!StringRef(*I).startswith("error"))
192 WarnOpts.push_back(*I);
193 }
194 WarnOpts.push_back("error=arc-unsafe-retained-assign");
Argyrios Kyrtzidisaa38f692012-06-20 01:46:26 +0000195 CInvok->getDiagnosticOpts().Warnings = llvm_move(WarnOpts);
Argyrios Kyrtzidis692bf8c2012-06-20 01:10:40 +0000196
John McCall3deb1ad2012-08-21 02:47:43 +0000197 CInvok->getLangOpts()->ObjCARCWeak = HasARCRuntime(origCI);
John McCalld70fb982011-06-15 23:25:17 +0000198
199 return CInvok.take();
200}
201
Benjamin Kramer3c05b7c2011-08-02 04:50:49 +0000202static void emitPremigrationErrors(const CapturedDiagList &arcDiags,
Douglas Gregor811db4e2012-10-23 22:26:28 +0000203 DiagnosticOptions *diagOpts,
Benjamin Kramer3c05b7c2011-08-02 04:50:49 +0000204 Preprocessor &PP) {
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000205 TextDiagnosticPrinter printer(llvm::errs(), diagOpts);
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000206 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
207 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000208 new DiagnosticsEngine(DiagID, diagOpts, &printer,
209 /*ShouldOwnClient=*/false));
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000210 Diags->setSourceManager(&PP.getSourceManager());
211
David Blaikiebbafb8a2012-03-11 07:00:24 +0000212 printer.BeginSourceFile(PP.getLangOpts(), &PP);
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000213 arcDiags.reportDiagnostics(*Diags);
214 printer.EndSourceFile();
215}
216
John McCalld70fb982011-06-15 23:25:17 +0000217//===----------------------------------------------------------------------===//
218// checkForManualIssues.
219//===----------------------------------------------------------------------===//
220
221bool arcmt::checkForManualIssues(CompilerInvocation &origCI,
Douglas Gregor32fbe312012-01-20 16:28:04 +0000222 const FrontendInputFile &Input,
David Blaikiee2eefae2011-09-25 23:39:51 +0000223 DiagnosticConsumer *DiagClient,
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000224 bool emitPremigrationARCErrors,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000225 StringRef plistOut) {
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000226 if (!origCI.getLangOpts()->ObjC1)
John McCalld70fb982011-06-15 23:25:17 +0000227 return false;
228
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000229 LangOptions::GCMode OrigGCMode = origCI.getLangOpts()->getGC();
Fariborz Jahanianaa7b9aa2012-01-25 00:20:29 +0000230 bool NoNSAllocReallocError = origCI.getMigratorOpts().NoNSAllocReallocError;
Fariborz Jahanian0c859d62012-01-26 00:08:04 +0000231 bool NoFinalizeRemoval = origCI.getMigratorOpts().NoFinalizeRemoval;
Argyrios Kyrtzidisd208ef92011-11-04 15:58:08 +0000232
Fariborz Jahanian48fd81b2012-01-26 20:57:58 +0000233 std::vector<TransformFn> transforms = arcmt::getAllTransformations(OrigGCMode,
234 NoFinalizeRemoval);
John McCalld70fb982011-06-15 23:25:17 +0000235 assert(!transforms.empty());
236
Dylan Noblesmithe2778992012-02-05 02:12:40 +0000237 OwningPtr<CompilerInvocation> CInvok;
John McCalld70fb982011-06-15 23:25:17 +0000238 CInvok.reset(createInvocationForMigration(origCI));
239 CInvok->getFrontendOpts().Inputs.clear();
Douglas Gregor32fbe312012-01-20 16:28:04 +0000240 CInvok->getFrontendOpts().Inputs.push_back(Input);
John McCalld70fb982011-06-15 23:25:17 +0000241
242 CapturedDiagList capturedDiags;
243
244 assert(DiagClient);
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000245 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
246 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000247 new DiagnosticsEngine(DiagID, &origCI.getDiagnosticOpts(),
248 DiagClient, /*ShouldOwnClient=*/false));
John McCalld70fb982011-06-15 23:25:17 +0000249
250 // Filter of all diagnostics.
Jordan Roseb00073d2012-08-10 01:06:16 +0000251 CaptureDiagnosticConsumer errRec(*Diags, *DiagClient, capturedDiags);
John McCalld70fb982011-06-15 23:25:17 +0000252 Diags->setClient(&errRec, /*ShouldOwnClient=*/false);
253
Dylan Noblesmithe2778992012-02-05 02:12:40 +0000254 OwningPtr<ASTUnit> Unit(
John McCalld70fb982011-06-15 23:25:17 +0000255 ASTUnit::LoadFromCompilerInvocationAction(CInvok.take(), Diags));
Jordan Roseb00073d2012-08-10 01:06:16 +0000256 if (!Unit) {
257 errRec.FinishCapture();
John McCalld70fb982011-06-15 23:25:17 +0000258 return true;
Jordan Roseb00073d2012-08-10 01:06:16 +0000259 }
John McCalld70fb982011-06-15 23:25:17 +0000260
261 // Don't filter diagnostics anymore.
262 Diags->setClient(DiagClient, /*ShouldOwnClient=*/false);
263
264 ASTContext &Ctx = Unit->getASTContext();
265
266 if (Diags->hasFatalErrorOccurred()) {
267 Diags->Reset();
David Blaikiebbafb8a2012-03-11 07:00:24 +0000268 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
John McCalld70fb982011-06-15 23:25:17 +0000269 capturedDiags.reportDiagnostics(*Diags);
270 DiagClient->EndSourceFile();
Jordan Roseb00073d2012-08-10 01:06:16 +0000271 errRec.FinishCapture();
John McCalld70fb982011-06-15 23:25:17 +0000272 return true;
273 }
274
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000275 if (emitPremigrationARCErrors)
Douglas Gregor811db4e2012-10-23 22:26:28 +0000276 emitPremigrationErrors(capturedDiags, &origCI.getDiagnosticOpts(),
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000277 Unit->getPreprocessor());
278 if (!plistOut.empty()) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000279 SmallVector<StoredDiagnostic, 8> arcDiags;
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000280 for (CapturedDiagList::iterator
281 I = capturedDiags.begin(), E = capturedDiags.end(); I != E; ++I)
282 arcDiags.push_back(*I);
283 writeARCDiagsToPlist(plistOut, arcDiags,
David Blaikiebbafb8a2012-03-11 07:00:24 +0000284 Ctx.getSourceManager(), Ctx.getLangOpts());
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000285 }
286
John McCalld70fb982011-06-15 23:25:17 +0000287 // After parsing of source files ended, we want to reuse the
288 // diagnostics objects to emit further diagnostics.
David Blaikiee2eefae2011-09-25 23:39:51 +0000289 // We call BeginSourceFile because DiagnosticConsumer requires that
John McCalld70fb982011-06-15 23:25:17 +0000290 // diagnostics with source range information are emitted only in between
291 // BeginSourceFile() and EndSourceFile().
David Blaikiebbafb8a2012-03-11 07:00:24 +0000292 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
John McCalld70fb982011-06-15 23:25:17 +0000293
294 // No macros will be added since we are just checking and we won't modify
295 // source code.
296 std::vector<SourceLocation> ARCMTMacroLocs;
297
298 TransformActions testAct(*Diags, capturedDiags, Ctx, Unit->getPreprocessor());
Argyrios Kyrtzidisd208ef92011-11-04 15:58:08 +0000299 MigrationPass pass(Ctx, OrigGCMode, Unit->getSema(), testAct, ARCMTMacroLocs);
Fariborz Jahanianaa7b9aa2012-01-25 00:20:29 +0000300 pass.setNSAllocReallocError(NoNSAllocReallocError);
Fariborz Jahanian0c859d62012-01-26 00:08:04 +0000301 pass.setNoFinalizeRemoval(NoFinalizeRemoval);
John McCalld70fb982011-06-15 23:25:17 +0000302
303 for (unsigned i=0, e = transforms.size(); i != e; ++i)
304 transforms[i](pass);
305
306 capturedDiags.reportDiagnostics(*Diags);
307
308 DiagClient->EndSourceFile();
Jordan Roseb00073d2012-08-10 01:06:16 +0000309 errRec.FinishCapture();
John McCalld70fb982011-06-15 23:25:17 +0000310
Argyrios Kyrtzidise2e40b42011-07-14 00:17:54 +0000311 // If we are migrating code that gets the '-fobjc-arc' flag, make sure
312 // to remove it so that we don't get errors from normal compilation.
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000313 origCI.getLangOpts()->ObjCAutoRefCount = false;
Argyrios Kyrtzidise2e40b42011-07-14 00:17:54 +0000314
Argyrios Kyrtzidis73a0d322011-07-18 07:44:45 +0000315 return capturedDiags.hasErrors() || testAct.hasReportedErrors();
John McCalld70fb982011-06-15 23:25:17 +0000316}
317
318//===----------------------------------------------------------------------===//
319// applyTransformations.
320//===----------------------------------------------------------------------===//
321
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000322static bool applyTransforms(CompilerInvocation &origCI,
Douglas Gregor32fbe312012-01-20 16:28:04 +0000323 const FrontendInputFile &Input,
David Blaikiee2eefae2011-09-25 23:39:51 +0000324 DiagnosticConsumer *DiagClient,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000325 StringRef outputDir,
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000326 bool emitPremigrationARCErrors,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000327 StringRef plistOut) {
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000328 if (!origCI.getLangOpts()->ObjC1)
John McCalld70fb982011-06-15 23:25:17 +0000329 return false;
330
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000331 LangOptions::GCMode OrigGCMode = origCI.getLangOpts()->getGC();
Argyrios Kyrtzidisd208ef92011-11-04 15:58:08 +0000332
John McCalld70fb982011-06-15 23:25:17 +0000333 // Make sure checking is successful first.
334 CompilerInvocation CInvokForCheck(origCI);
Douglas Gregor32fbe312012-01-20 16:28:04 +0000335 if (arcmt::checkForManualIssues(CInvokForCheck, Input, DiagClient,
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000336 emitPremigrationARCErrors, plistOut))
John McCalld70fb982011-06-15 23:25:17 +0000337 return true;
338
339 CompilerInvocation CInvok(origCI);
340 CInvok.getFrontendOpts().Inputs.clear();
Douglas Gregor32fbe312012-01-20 16:28:04 +0000341 CInvok.getFrontendOpts().Inputs.push_back(Input);
John McCalld70fb982011-06-15 23:25:17 +0000342
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000343 MigrationProcess migration(CInvok, DiagClient, outputDir);
Fariborz Jahanian48fd81b2012-01-26 20:57:58 +0000344 bool NoFinalizeRemoval = origCI.getMigratorOpts().NoFinalizeRemoval;
John McCalld70fb982011-06-15 23:25:17 +0000345
Fariborz Jahanian48fd81b2012-01-26 20:57:58 +0000346 std::vector<TransformFn> transforms = arcmt::getAllTransformations(OrigGCMode,
347 NoFinalizeRemoval);
John McCalld70fb982011-06-15 23:25:17 +0000348 assert(!transforms.empty());
349
350 for (unsigned i=0, e = transforms.size(); i != e; ++i) {
351 bool err = migration.applyTransform(transforms[i]);
352 if (err) return true;
353 }
354
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000355 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
356 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000357 new DiagnosticsEngine(DiagID, &origCI.getDiagnosticOpts(),
358 DiagClient, /*ShouldOwnClient=*/false));
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000359
360 if (outputDir.empty()) {
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000361 origCI.getLangOpts()->ObjCAutoRefCount = true;
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000362 return migration.getRemapper().overwriteOriginal(*Diags);
Argyrios Kyrtzidise2e40b42011-07-14 00:17:54 +0000363 } else {
364 // If we are migrating code that gets the '-fobjc-arc' flag, make sure
365 // to remove it so that we don't get errors from normal compilation.
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000366 origCI.getLangOpts()->ObjCAutoRefCount = false;
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000367 return migration.getRemapper().flushToDisk(outputDir, *Diags);
Argyrios Kyrtzidise2e40b42011-07-14 00:17:54 +0000368 }
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000369}
370
371bool arcmt::applyTransformations(CompilerInvocation &origCI,
Douglas Gregor32fbe312012-01-20 16:28:04 +0000372 const FrontendInputFile &Input,
David Blaikiee2eefae2011-09-25 23:39:51 +0000373 DiagnosticConsumer *DiagClient) {
Douglas Gregor32fbe312012-01-20 16:28:04 +0000374 return applyTransforms(origCI, Input, DiagClient,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000375 StringRef(), false, StringRef());
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000376}
377
378bool arcmt::migrateWithTemporaryFiles(CompilerInvocation &origCI,
Douglas Gregor32fbe312012-01-20 16:28:04 +0000379 const FrontendInputFile &Input,
David Blaikiee2eefae2011-09-25 23:39:51 +0000380 DiagnosticConsumer *DiagClient,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000381 StringRef outputDir,
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000382 bool emitPremigrationARCErrors,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000383 StringRef plistOut) {
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000384 assert(!outputDir.empty() && "Expected output directory path");
Douglas Gregor32fbe312012-01-20 16:28:04 +0000385 return applyTransforms(origCI, Input, DiagClient,
Argyrios Kyrtzidisd5713632011-07-19 17:20:03 +0000386 outputDir, emitPremigrationARCErrors, plistOut);
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000387}
388
389bool arcmt::getFileRemappings(std::vector<std::pair<std::string,std::string> > &
390 remap,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000391 StringRef outputDir,
David Blaikiee2eefae2011-09-25 23:39:51 +0000392 DiagnosticConsumer *DiagClient) {
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000393 assert(!outputDir.empty());
John McCalld70fb982011-06-15 23:25:17 +0000394
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000395 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
396 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000397 new DiagnosticsEngine(DiagID, new DiagnosticOptions,
398 DiagClient, /*ShouldOwnClient=*/false));
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000399
400 FileRemapper remapper;
401 bool err = remapper.initFromDisk(outputDir, *Diags,
402 /*ignoreIfFilesChanged=*/true);
403 if (err)
404 return true;
405
Ted Kremenekf7639e12012-03-06 20:06:33 +0000406 PreprocessorOptions PPOpts;
407 remapper.applyMappings(PPOpts);
408 remap = PPOpts.RemappedFiles;
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000409
410 return false;
John McCalld70fb982011-06-15 23:25:17 +0000411}
412
Ted Kremenekf7639e12012-03-06 20:06:33 +0000413bool arcmt::getFileRemappingsFromFileList(
414 std::vector<std::pair<std::string,std::string> > &remap,
415 ArrayRef<StringRef> remapFiles,
416 DiagnosticConsumer *DiagClient) {
417 bool hasErrorOccurred = false;
418 llvm::StringMap<bool> Uniquer;
419
420 llvm::IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
421 llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000422 new DiagnosticsEngine(DiagID, new DiagnosticOptions,
423 DiagClient, /*ShouldOwnClient=*/false));
Ted Kremenekf7639e12012-03-06 20:06:33 +0000424
425 for (ArrayRef<StringRef>::iterator
426 I = remapFiles.begin(), E = remapFiles.end(); I != E; ++I) {
427 StringRef file = *I;
428
429 FileRemapper remapper;
430 bool err = remapper.initFromFile(file, *Diags,
431 /*ignoreIfFilesChanged=*/true);
432 hasErrorOccurred = hasErrorOccurred || err;
433 if (err)
434 continue;
435
436 PreprocessorOptions PPOpts;
437 remapper.applyMappings(PPOpts);
438 for (PreprocessorOptions::remapped_file_iterator
439 RI = PPOpts.remapped_file_begin(), RE = PPOpts.remapped_file_end();
440 RI != RE; ++RI) {
441 bool &inserted = Uniquer[RI->first];
442 if (inserted)
443 continue;
444 inserted = true;
445 remap.push_back(*RI);
446 }
447 }
448
449 return hasErrorOccurred;
450}
451
John McCalld70fb982011-06-15 23:25:17 +0000452//===----------------------------------------------------------------------===//
John McCalld70fb982011-06-15 23:25:17 +0000453// CollectTransformActions.
454//===----------------------------------------------------------------------===//
455
456namespace {
457
458class ARCMTMacroTrackerPPCallbacks : public PPCallbacks {
459 std::vector<SourceLocation> &ARCMTMacroLocs;
460
461public:
462 ARCMTMacroTrackerPPCallbacks(std::vector<SourceLocation> &ARCMTMacroLocs)
463 : ARCMTMacroLocs(ARCMTMacroLocs) { }
464
Argyrios Kyrtzidis85a14bb2011-08-18 01:05:45 +0000465 virtual void MacroExpands(const Token &MacroNameTok, const MacroInfo *MI,
466 SourceRange Range) {
John McCalld70fb982011-06-15 23:25:17 +0000467 if (MacroNameTok.getIdentifierInfo()->getName() == getARCMTMacroName())
468 ARCMTMacroLocs.push_back(MacroNameTok.getLocation());
469 }
470};
471
472class ARCMTMacroTrackerAction : public ASTFrontendAction {
473 std::vector<SourceLocation> &ARCMTMacroLocs;
474
475public:
476 ARCMTMacroTrackerAction(std::vector<SourceLocation> &ARCMTMacroLocs)
477 : ARCMTMacroLocs(ARCMTMacroLocs) { }
478
479 virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000480 StringRef InFile) {
John McCalld70fb982011-06-15 23:25:17 +0000481 CI.getPreprocessor().addPPCallbacks(
482 new ARCMTMacroTrackerPPCallbacks(ARCMTMacroLocs));
483 return new ASTConsumer();
484 }
485};
486
487class RewritesApplicator : public TransformActions::RewriteReceiver {
488 Rewriter &rewriter;
John McCalld70fb982011-06-15 23:25:17 +0000489 MigrationProcess::RewriteListener *Listener;
490
491public:
492 RewritesApplicator(Rewriter &rewriter, ASTContext &ctx,
493 MigrationProcess::RewriteListener *listener)
Benjamin Kramerd1d76b22012-06-06 17:32:50 +0000494 : rewriter(rewriter), Listener(listener) {
John McCalld70fb982011-06-15 23:25:17 +0000495 if (Listener)
496 Listener->start(ctx);
497 }
498 ~RewritesApplicator() {
499 if (Listener)
500 Listener->finish();
501 }
502
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000503 virtual void insert(SourceLocation loc, StringRef text) {
John McCalld70fb982011-06-15 23:25:17 +0000504 bool err = rewriter.InsertText(loc, text, /*InsertAfter=*/true,
505 /*indentNewLines=*/true);
506 if (!err && Listener)
507 Listener->insert(loc, text);
508 }
509
510 virtual void remove(CharSourceRange range) {
511 Rewriter::RewriteOptions removeOpts;
512 removeOpts.IncludeInsertsAtBeginOfRange = false;
513 removeOpts.IncludeInsertsAtEndOfRange = false;
514 removeOpts.RemoveLineIfEmpty = true;
515
516 bool err = rewriter.RemoveText(range, removeOpts);
517 if (!err && Listener)
518 Listener->remove(range);
519 }
520
521 virtual void increaseIndentation(CharSourceRange range,
522 SourceLocation parentIndent) {
523 rewriter.IncreaseIndentation(range, parentIndent);
524 }
525};
526
527} // end anonymous namespace.
528
529/// \brief Anchor for VTable.
530MigrationProcess::RewriteListener::~RewriteListener() { }
531
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000532MigrationProcess::MigrationProcess(const CompilerInvocation &CI,
David Blaikiee2eefae2011-09-25 23:39:51 +0000533 DiagnosticConsumer *diagClient,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000534 StringRef outputDir)
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000535 : OrigCI(CI), DiagClient(diagClient) {
536 if (!outputDir.empty()) {
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000537 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
538 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000539 new DiagnosticsEngine(DiagID, &CI.getDiagnosticOpts(),
540 DiagClient, /*ShouldOwnClient=*/false));
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000541 Remapper.initFromDisk(outputDir, *Diags, /*ignoreIfFilesChanges=*/true);
542 }
543}
544
John McCalld70fb982011-06-15 23:25:17 +0000545bool MigrationProcess::applyTransform(TransformFn trans,
546 RewriteListener *listener) {
Dylan Noblesmithe2778992012-02-05 02:12:40 +0000547 OwningPtr<CompilerInvocation> CInvok;
John McCalld70fb982011-06-15 23:25:17 +0000548 CInvok.reset(createInvocationForMigration(OrigCI));
549 CInvok->getDiagnosticOpts().IgnoreWarnings = true;
550
Ted Kremenekf7639e12012-03-06 20:06:33 +0000551 Remapper.applyMappings(CInvok->getPreprocessorOpts());
John McCalld70fb982011-06-15 23:25:17 +0000552
553 CapturedDiagList capturedDiags;
554 std::vector<SourceLocation> ARCMTMacroLocs;
555
556 assert(DiagClient);
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000557 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
558 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000559 new DiagnosticsEngine(DiagID, new DiagnosticOptions,
560 DiagClient, /*ShouldOwnClient=*/false));
John McCalld70fb982011-06-15 23:25:17 +0000561
562 // Filter of all diagnostics.
Jordan Roseb00073d2012-08-10 01:06:16 +0000563 CaptureDiagnosticConsumer errRec(*Diags, *DiagClient, capturedDiags);
John McCalld70fb982011-06-15 23:25:17 +0000564 Diags->setClient(&errRec, /*ShouldOwnClient=*/false);
565
Dylan Noblesmithe2778992012-02-05 02:12:40 +0000566 OwningPtr<ARCMTMacroTrackerAction> ASTAction;
John McCalld70fb982011-06-15 23:25:17 +0000567 ASTAction.reset(new ARCMTMacroTrackerAction(ARCMTMacroLocs));
568
Dylan Noblesmithe2778992012-02-05 02:12:40 +0000569 OwningPtr<ASTUnit> Unit(
John McCalld70fb982011-06-15 23:25:17 +0000570 ASTUnit::LoadFromCompilerInvocationAction(CInvok.take(), Diags,
571 ASTAction.get()));
Jordan Roseb00073d2012-08-10 01:06:16 +0000572 if (!Unit) {
573 errRec.FinishCapture();
John McCalld70fb982011-06-15 23:25:17 +0000574 return true;
Jordan Roseb00073d2012-08-10 01:06:16 +0000575 }
John McCalld70fb982011-06-15 23:25:17 +0000576 Unit->setOwnsRemappedFileBuffers(false); // FileRemapper manages that.
577
578 // Don't filter diagnostics anymore.
579 Diags->setClient(DiagClient, /*ShouldOwnClient=*/false);
580
581 ASTContext &Ctx = Unit->getASTContext();
582
583 if (Diags->hasFatalErrorOccurred()) {
584 Diags->Reset();
David Blaikiebbafb8a2012-03-11 07:00:24 +0000585 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
John McCalld70fb982011-06-15 23:25:17 +0000586 capturedDiags.reportDiagnostics(*Diags);
587 DiagClient->EndSourceFile();
Jordan Roseb00073d2012-08-10 01:06:16 +0000588 errRec.FinishCapture();
John McCalld70fb982011-06-15 23:25:17 +0000589 return true;
590 }
591
592 // After parsing of source files ended, we want to reuse the
593 // diagnostics objects to emit further diagnostics.
David Blaikiee2eefae2011-09-25 23:39:51 +0000594 // We call BeginSourceFile because DiagnosticConsumer requires that
John McCalld70fb982011-06-15 23:25:17 +0000595 // diagnostics with source range information are emitted only in between
596 // BeginSourceFile() and EndSourceFile().
David Blaikiebbafb8a2012-03-11 07:00:24 +0000597 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
John McCalld70fb982011-06-15 23:25:17 +0000598
David Blaikiebbafb8a2012-03-11 07:00:24 +0000599 Rewriter rewriter(Ctx.getSourceManager(), Ctx.getLangOpts());
John McCalld70fb982011-06-15 23:25:17 +0000600 TransformActions TA(*Diags, capturedDiags, Ctx, Unit->getPreprocessor());
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000601 MigrationPass pass(Ctx, OrigCI.getLangOpts()->getGC(),
Argyrios Kyrtzidisd208ef92011-11-04 15:58:08 +0000602 Unit->getSema(), TA, ARCMTMacroLocs);
John McCalld70fb982011-06-15 23:25:17 +0000603
604 trans(pass);
605
606 {
607 RewritesApplicator applicator(rewriter, Ctx, listener);
608 TA.applyRewrites(applicator);
609 }
610
611 DiagClient->EndSourceFile();
Jordan Roseb00073d2012-08-10 01:06:16 +0000612 errRec.FinishCapture();
John McCalld70fb982011-06-15 23:25:17 +0000613
614 if (DiagClient->getNumErrors())
615 return true;
616
617 for (Rewriter::buffer_iterator
618 I = rewriter.buffer_begin(), E = rewriter.buffer_end(); I != E; ++I) {
619 FileID FID = I->first;
620 RewriteBuffer &buf = I->second;
621 const FileEntry *file = Ctx.getSourceManager().getFileEntryForID(FID);
622 assert(file);
623 std::string newFname = file->getName();
624 newFname += "-trans";
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000625 SmallString<512> newText;
John McCalld70fb982011-06-15 23:25:17 +0000626 llvm::raw_svector_ostream vecOS(newText);
627 buf.write(vecOS);
628 vecOS.flush();
629 llvm::MemoryBuffer *memBuf = llvm::MemoryBuffer::getMemBufferCopy(
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000630 StringRef(newText.data(), newText.size()), newFname);
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000631 SmallString<64> filePath(file->getName());
John McCalld70fb982011-06-15 23:25:17 +0000632 Unit->getFileManager().FixupRelativePath(filePath);
633 Remapper.remap(filePath.str(), memBuf);
634 }
635
636 return false;
637}