1 //===--- ARCMT.cpp - Migration to ARC mode --------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "Internals.h"
11 #include "clang/AST/ASTConsumer.h"
12 #include "clang/Basic/DiagnosticCategories.h"
13 #include "clang/Frontend/ASTUnit.h"
14 #include "clang/Frontend/CompilerInstance.h"
15 #include "clang/Frontend/FrontendAction.h"
16 #include "clang/Frontend/TextDiagnosticPrinter.h"
17 #include "clang/Frontend/Utils.h"
18 #include "clang/Lex/Preprocessor.h"
19 #include "clang/Rewrite/Core/Rewriter.h"
20 #include "clang/Sema/SemaDiagnostic.h"
21 #include "clang/Serialization/ASTReader.h"
22 #include "llvm/ADT/Triple.h"
23 #include "llvm/Support/MemoryBuffer.h"
24 using namespace clang;
25 using namespace arcmt;
27 bool CapturedDiagList::clearDiagnostic(ArrayRef<unsigned> IDs,
29 if (range.isInvalid())
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()))) {
42 ListTy::iterator eraseS = I++;
43 if (eraseS->getLevel() != DiagnosticsEngine::Note)
44 while (I != List.end() && I->getLevel() == DiagnosticsEngine::Note)
46 // Clear the diagnostic and any notes following it.
47 I = List.erase(eraseS, I);
57 bool CapturedDiagList::hasDiagnostic(ArrayRef<unsigned> IDs,
58 SourceRange range) const {
59 if (range.isInvalid())
62 ListTy::const_iterator I = List.begin();
63 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()))) {
79 void CapturedDiagList::reportDiagnostics(DiagnosticsEngine &Diags) const {
80 for (ListTy::const_iterator I = List.begin(), E = List.end(); I != E; ++I)
84 bool CapturedDiagList::hasErrors() const {
85 for (ListTy::const_iterator I = List.begin(), E = List.end(); I != E; ++I)
86 if (I->getLevel() >= DiagnosticsEngine::Error)
94 class CaptureDiagnosticConsumer : public DiagnosticConsumer {
95 DiagnosticsEngine &Diags;
96 DiagnosticConsumer &DiagClient;
97 CapturedDiagList &CapturedDiags;
98 bool HasBegunSourceFile;
100 CaptureDiagnosticConsumer(DiagnosticsEngine &diags,
101 DiagnosticConsumer &client,
102 CapturedDiagList &capturedDiags)
103 : Diags(diags), DiagClient(client), CapturedDiags(capturedDiags),
104 HasBegunSourceFile(false) { }
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;
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;
127 virtual ~CaptureDiagnosticConsumer() {
128 assert(!HasBegunSourceFile && "FinishCapture not called!");
131 virtual void HandleDiagnostic(DiagnosticsEngine::Level level,
132 const Diagnostic &Info) {
133 if (DiagnosticIDs::isARCDiagnostic(Info.getID()) ||
134 level >= DiagnosticsEngine::Error || level == DiagnosticsEngine::Note) {
135 if (Info.getLocation().isValid())
136 CapturedDiags.push_back(StoredDiagnostic(level, Info));
140 // Non-ARC warnings are ignored.
141 Diags.setLastDiagnosticIgnored();
145 } // end anonymous namespace
147 static bool HasARCRuntime(CompilerInvocation &origCI) {
148 // This duplicates some functionality from Darwin::AddDeploymentTarget
149 // but this function is well defined, so keep it decoupled from the driver
150 // and avoid unrelated complications.
151 llvm::Triple triple(origCI.getTargetOpts().Triple);
154 return triple.getOSMajorVersion() >= 5;
156 if (triple.getOS() == llvm::Triple::Darwin)
157 return triple.getOSMajorVersion() >= 11;
159 if (triple.getOS() == llvm::Triple::MacOSX) {
160 unsigned Major, Minor, Micro;
161 triple.getOSVersion(Major, Minor, Micro);
162 return Major > 10 || (Major == 10 && Minor >= 7);
168 static CompilerInvocation *
169 createInvocationForMigration(CompilerInvocation &origCI) {
170 OwningPtr<CompilerInvocation> CInvok;
171 CInvok.reset(new CompilerInvocation(origCI));
172 PreprocessorOptions &PPOpts = CInvok->getPreprocessorOpts();
173 if (!PPOpts.ImplicitPCHInclude.empty()) {
174 // We can't use a PCH because it was likely built in non-ARC mode and we
175 // want to parse in ARC. Include the original header.
176 FileManager FileMgr(origCI.getFileSystemOpts());
177 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
178 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
179 new DiagnosticsEngine(DiagID, &origCI.getDiagnosticOpts(),
180 new IgnoringDiagConsumer()));
181 std::string OriginalFile =
182 ASTReader::getOriginalSourceFile(PPOpts.ImplicitPCHInclude,
184 if (!OriginalFile.empty())
185 PPOpts.Includes.insert(PPOpts.Includes.begin(), OriginalFile);
186 PPOpts.ImplicitPCHInclude.clear();
188 // FIXME: Get the original header of a PTH as well.
189 CInvok->getPreprocessorOpts().ImplicitPTHInclude.clear();
190 std::string define = getARCMTMacroName();
192 CInvok->getPreprocessorOpts().addMacroDef(define);
193 CInvok->getLangOpts()->ObjCAutoRefCount = true;
194 CInvok->getLangOpts()->setGC(LangOptions::NonGC);
195 CInvok->getDiagnosticOpts().ErrorLimit = 0;
196 CInvok->getDiagnosticOpts().PedanticErrors = 0;
198 // Ignore -Werror flags when migrating.
199 std::vector<std::string> WarnOpts;
200 for (std::vector<std::string>::iterator
201 I = CInvok->getDiagnosticOpts().Warnings.begin(),
202 E = CInvok->getDiagnosticOpts().Warnings.end(); I != E; ++I) {
203 if (!StringRef(*I).startswith("error"))
204 WarnOpts.push_back(*I);
206 WarnOpts.push_back("error=arc-unsafe-retained-assign");
207 CInvok->getDiagnosticOpts().Warnings = llvm_move(WarnOpts);
209 CInvok->getLangOpts()->ObjCARCWeak = HasARCRuntime(origCI);
211 return CInvok.take();
214 static void emitPremigrationErrors(const CapturedDiagList &arcDiags,
215 DiagnosticOptions *diagOpts,
217 TextDiagnosticPrinter printer(llvm::errs(), diagOpts);
218 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
219 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
220 new DiagnosticsEngine(DiagID, diagOpts, &printer,
221 /*ShouldOwnClient=*/false));
222 Diags->setSourceManager(&PP.getSourceManager());
224 printer.BeginSourceFile(PP.getLangOpts(), &PP);
225 arcDiags.reportDiagnostics(*Diags);
226 printer.EndSourceFile();
229 //===----------------------------------------------------------------------===//
230 // checkForManualIssues.
231 //===----------------------------------------------------------------------===//
233 bool arcmt::checkForManualIssues(CompilerInvocation &origCI,
234 const FrontendInputFile &Input,
235 DiagnosticConsumer *DiagClient,
236 bool emitPremigrationARCErrors,
237 StringRef plistOut) {
238 if (!origCI.getLangOpts()->ObjC1)
241 LangOptions::GCMode OrigGCMode = origCI.getLangOpts()->getGC();
242 bool NoNSAllocReallocError = origCI.getMigratorOpts().NoNSAllocReallocError;
243 bool NoFinalizeRemoval = origCI.getMigratorOpts().NoFinalizeRemoval;
245 std::vector<TransformFn> transforms = arcmt::getAllTransformations(OrigGCMode,
247 assert(!transforms.empty());
249 OwningPtr<CompilerInvocation> CInvok;
250 CInvok.reset(createInvocationForMigration(origCI));
251 CInvok->getFrontendOpts().Inputs.clear();
252 CInvok->getFrontendOpts().Inputs.push_back(Input);
254 CapturedDiagList capturedDiags;
257 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
258 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
259 new DiagnosticsEngine(DiagID, &origCI.getDiagnosticOpts(),
260 DiagClient, /*ShouldOwnClient=*/false));
262 // Filter of all diagnostics.
263 CaptureDiagnosticConsumer errRec(*Diags, *DiagClient, capturedDiags);
264 Diags->setClient(&errRec, /*ShouldOwnClient=*/false);
266 OwningPtr<ASTUnit> Unit(
267 ASTUnit::LoadFromCompilerInvocationAction(CInvok.take(), Diags));
269 errRec.FinishCapture();
273 // Don't filter diagnostics anymore.
274 Diags->setClient(DiagClient, /*ShouldOwnClient=*/false);
276 ASTContext &Ctx = Unit->getASTContext();
278 if (Diags->hasFatalErrorOccurred()) {
280 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
281 capturedDiags.reportDiagnostics(*Diags);
282 DiagClient->EndSourceFile();
283 errRec.FinishCapture();
287 if (emitPremigrationARCErrors)
288 emitPremigrationErrors(capturedDiags, &origCI.getDiagnosticOpts(),
289 Unit->getPreprocessor());
290 if (!plistOut.empty()) {
291 SmallVector<StoredDiagnostic, 8> arcDiags;
292 for (CapturedDiagList::iterator
293 I = capturedDiags.begin(), E = capturedDiags.end(); I != E; ++I)
294 arcDiags.push_back(*I);
295 writeARCDiagsToPlist(plistOut, arcDiags,
296 Ctx.getSourceManager(), Ctx.getLangOpts());
299 // After parsing of source files ended, we want to reuse the
300 // diagnostics objects to emit further diagnostics.
301 // We call BeginSourceFile because DiagnosticConsumer requires that
302 // diagnostics with source range information are emitted only in between
303 // BeginSourceFile() and EndSourceFile().
304 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
306 // No macros will be added since we are just checking and we won't modify
308 std::vector<SourceLocation> ARCMTMacroLocs;
310 TransformActions testAct(*Diags, capturedDiags, Ctx, Unit->getPreprocessor());
311 MigrationPass pass(Ctx, OrigGCMode, Unit->getSema(), testAct, capturedDiags,
313 pass.setNSAllocReallocError(NoNSAllocReallocError);
314 pass.setNoFinalizeRemoval(NoFinalizeRemoval);
316 for (unsigned i=0, e = transforms.size(); i != e; ++i)
319 capturedDiags.reportDiagnostics(*Diags);
321 DiagClient->EndSourceFile();
322 errRec.FinishCapture();
324 return capturedDiags.hasErrors() || testAct.hasReportedErrors();
327 //===----------------------------------------------------------------------===//
328 // applyTransformations.
329 //===----------------------------------------------------------------------===//
331 static bool applyTransforms(CompilerInvocation &origCI,
332 const FrontendInputFile &Input,
333 DiagnosticConsumer *DiagClient,
335 bool emitPremigrationARCErrors,
336 StringRef plistOut) {
337 if (!origCI.getLangOpts()->ObjC1)
340 LangOptions::GCMode OrigGCMode = origCI.getLangOpts()->getGC();
342 // Make sure checking is successful first.
343 CompilerInvocation CInvokForCheck(origCI);
344 if (arcmt::checkForManualIssues(CInvokForCheck, Input, DiagClient,
345 emitPremigrationARCErrors, plistOut))
348 CompilerInvocation CInvok(origCI);
349 CInvok.getFrontendOpts().Inputs.clear();
350 CInvok.getFrontendOpts().Inputs.push_back(Input);
352 MigrationProcess migration(CInvok, DiagClient, outputDir);
353 bool NoFinalizeRemoval = origCI.getMigratorOpts().NoFinalizeRemoval;
355 std::vector<TransformFn> transforms = arcmt::getAllTransformations(OrigGCMode,
357 assert(!transforms.empty());
359 for (unsigned i=0, e = transforms.size(); i != e; ++i) {
360 bool err = migration.applyTransform(transforms[i]);
361 if (err) return true;
364 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
365 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
366 new DiagnosticsEngine(DiagID, &origCI.getDiagnosticOpts(),
367 DiagClient, /*ShouldOwnClient=*/false));
369 if (outputDir.empty()) {
370 origCI.getLangOpts()->ObjCAutoRefCount = true;
371 return migration.getRemapper().overwriteOriginal(*Diags);
373 return migration.getRemapper().flushToDisk(outputDir, *Diags);
377 bool arcmt::applyTransformations(CompilerInvocation &origCI,
378 const FrontendInputFile &Input,
379 DiagnosticConsumer *DiagClient) {
380 return applyTransforms(origCI, Input, DiagClient,
381 StringRef(), false, StringRef());
384 bool arcmt::migrateWithTemporaryFiles(CompilerInvocation &origCI,
385 const FrontendInputFile &Input,
386 DiagnosticConsumer *DiagClient,
388 bool emitPremigrationARCErrors,
389 StringRef plistOut) {
390 assert(!outputDir.empty() && "Expected output directory path");
391 return applyTransforms(origCI, Input, DiagClient,
392 outputDir, emitPremigrationARCErrors, plistOut);
395 bool arcmt::getFileRemappings(std::vector<std::pair<std::string,std::string> > &
398 DiagnosticConsumer *DiagClient) {
399 assert(!outputDir.empty());
401 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
402 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
403 new DiagnosticsEngine(DiagID, new DiagnosticOptions,
404 DiagClient, /*ShouldOwnClient=*/false));
406 FileRemapper remapper;
407 bool err = remapper.initFromDisk(outputDir, *Diags,
408 /*ignoreIfFilesChanged=*/true);
412 PreprocessorOptions PPOpts;
413 remapper.applyMappings(PPOpts);
414 remap = PPOpts.RemappedFiles;
419 bool arcmt::getFileRemappingsFromFileList(
420 std::vector<std::pair<std::string,std::string> > &remap,
421 ArrayRef<StringRef> remapFiles,
422 DiagnosticConsumer *DiagClient) {
423 bool hasErrorOccurred = false;
424 llvm::StringMap<bool> Uniquer;
426 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
427 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
428 new DiagnosticsEngine(DiagID, new DiagnosticOptions,
429 DiagClient, /*ShouldOwnClient=*/false));
431 for (ArrayRef<StringRef>::iterator
432 I = remapFiles.begin(), E = remapFiles.end(); I != E; ++I) {
435 FileRemapper remapper;
436 bool err = remapper.initFromFile(file, *Diags,
437 /*ignoreIfFilesChanged=*/true);
438 hasErrorOccurred = hasErrorOccurred || err;
442 PreprocessorOptions PPOpts;
443 remapper.applyMappings(PPOpts);
444 for (PreprocessorOptions::remapped_file_iterator
445 RI = PPOpts.remapped_file_begin(), RE = PPOpts.remapped_file_end();
447 bool &inserted = Uniquer[RI->first];
451 remap.push_back(*RI);
455 return hasErrorOccurred;
458 //===----------------------------------------------------------------------===//
459 // CollectTransformActions.
460 //===----------------------------------------------------------------------===//
464 class ARCMTMacroTrackerPPCallbacks : public PPCallbacks {
465 std::vector<SourceLocation> &ARCMTMacroLocs;
468 ARCMTMacroTrackerPPCallbacks(std::vector<SourceLocation> &ARCMTMacroLocs)
469 : ARCMTMacroLocs(ARCMTMacroLocs) { }
471 virtual void MacroExpands(const Token &MacroNameTok, const MacroDirective *MD,
472 SourceRange Range, const MacroArgs *Args) {
473 if (MacroNameTok.getIdentifierInfo()->getName() == getARCMTMacroName())
474 ARCMTMacroLocs.push_back(MacroNameTok.getLocation());
478 class ARCMTMacroTrackerAction : public ASTFrontendAction {
479 std::vector<SourceLocation> &ARCMTMacroLocs;
482 ARCMTMacroTrackerAction(std::vector<SourceLocation> &ARCMTMacroLocs)
483 : ARCMTMacroLocs(ARCMTMacroLocs) { }
485 virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI,
487 CI.getPreprocessor().addPPCallbacks(
488 new ARCMTMacroTrackerPPCallbacks(ARCMTMacroLocs));
489 return new ASTConsumer();
493 class RewritesApplicator : public TransformActions::RewriteReceiver {
495 MigrationProcess::RewriteListener *Listener;
498 RewritesApplicator(Rewriter &rewriter, ASTContext &ctx,
499 MigrationProcess::RewriteListener *listener)
500 : rewriter(rewriter), Listener(listener) {
502 Listener->start(ctx);
504 ~RewritesApplicator() {
509 virtual void insert(SourceLocation loc, StringRef text) {
510 bool err = rewriter.InsertText(loc, text, /*InsertAfter=*/true,
511 /*indentNewLines=*/true);
512 if (!err && Listener)
513 Listener->insert(loc, text);
516 virtual void remove(CharSourceRange range) {
517 Rewriter::RewriteOptions removeOpts;
518 removeOpts.IncludeInsertsAtBeginOfRange = false;
519 removeOpts.IncludeInsertsAtEndOfRange = false;
520 removeOpts.RemoveLineIfEmpty = true;
522 bool err = rewriter.RemoveText(range, removeOpts);
523 if (!err && Listener)
524 Listener->remove(range);
527 virtual void increaseIndentation(CharSourceRange range,
528 SourceLocation parentIndent) {
529 rewriter.IncreaseIndentation(range, parentIndent);
533 } // end anonymous namespace.
535 /// \brief Anchor for VTable.
536 MigrationProcess::RewriteListener::~RewriteListener() { }
538 MigrationProcess::MigrationProcess(const CompilerInvocation &CI,
539 DiagnosticConsumer *diagClient,
541 : OrigCI(CI), DiagClient(diagClient), HadARCErrors(false) {
542 if (!outputDir.empty()) {
543 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
544 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
545 new DiagnosticsEngine(DiagID, &CI.getDiagnosticOpts(),
546 DiagClient, /*ShouldOwnClient=*/false));
547 Remapper.initFromDisk(outputDir, *Diags, /*ignoreIfFilesChanges=*/true);
551 bool MigrationProcess::applyTransform(TransformFn trans,
552 RewriteListener *listener) {
553 OwningPtr<CompilerInvocation> CInvok;
554 CInvok.reset(createInvocationForMigration(OrigCI));
555 CInvok->getDiagnosticOpts().IgnoreWarnings = true;
557 Remapper.applyMappings(CInvok->getPreprocessorOpts());
559 CapturedDiagList capturedDiags;
560 std::vector<SourceLocation> ARCMTMacroLocs;
563 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
564 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
565 new DiagnosticsEngine(DiagID, new DiagnosticOptions,
566 DiagClient, /*ShouldOwnClient=*/false));
568 // Filter of all diagnostics.
569 CaptureDiagnosticConsumer errRec(*Diags, *DiagClient, capturedDiags);
570 Diags->setClient(&errRec, /*ShouldOwnClient=*/false);
572 OwningPtr<ARCMTMacroTrackerAction> ASTAction;
573 ASTAction.reset(new ARCMTMacroTrackerAction(ARCMTMacroLocs));
575 OwningPtr<ASTUnit> Unit(
576 ASTUnit::LoadFromCompilerInvocationAction(CInvok.take(), Diags,
579 errRec.FinishCapture();
582 Unit->setOwnsRemappedFileBuffers(false); // FileRemapper manages that.
584 HadARCErrors = HadARCErrors || capturedDiags.hasErrors();
586 // Don't filter diagnostics anymore.
587 Diags->setClient(DiagClient, /*ShouldOwnClient=*/false);
589 ASTContext &Ctx = Unit->getASTContext();
591 if (Diags->hasFatalErrorOccurred()) {
593 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
594 capturedDiags.reportDiagnostics(*Diags);
595 DiagClient->EndSourceFile();
596 errRec.FinishCapture();
600 // After parsing of source files ended, we want to reuse the
601 // diagnostics objects to emit further diagnostics.
602 // We call BeginSourceFile because DiagnosticConsumer requires that
603 // diagnostics with source range information are emitted only in between
604 // BeginSourceFile() and EndSourceFile().
605 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
607 Rewriter rewriter(Ctx.getSourceManager(), Ctx.getLangOpts());
608 TransformActions TA(*Diags, capturedDiags, Ctx, Unit->getPreprocessor());
609 MigrationPass pass(Ctx, OrigCI.getLangOpts()->getGC(),
610 Unit->getSema(), TA, capturedDiags, ARCMTMacroLocs);
615 RewritesApplicator applicator(rewriter, Ctx, listener);
616 TA.applyRewrites(applicator);
619 DiagClient->EndSourceFile();
620 errRec.FinishCapture();
622 if (DiagClient->getNumErrors())
625 for (Rewriter::buffer_iterator
626 I = rewriter.buffer_begin(), E = rewriter.buffer_end(); I != E; ++I) {
627 FileID FID = I->first;
628 RewriteBuffer &buf = I->second;
629 const FileEntry *file = Ctx.getSourceManager().getFileEntryForID(FID);
631 std::string newFname = file->getName();
632 newFname += "-trans";
633 SmallString<512> newText;
634 llvm::raw_svector_ostream vecOS(newText);
637 llvm::MemoryBuffer *memBuf = llvm::MemoryBuffer::getMemBufferCopy(
638 StringRef(newText.data(), newText.size()), newFname);
639 SmallString<64> filePath(file->getName());
640 Unit->getFileManager().FixupRelativePath(filePath);
641 Remapper.remap(filePath.str(), memBuf);