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/ASTContext.h"
12 #include "clang/AST/Expr.h"
13 #include "clang/Basic/SourceManager.h"
14 #include "clang/Lex/Preprocessor.h"
15 #include "llvm/ADT/DenseSet.h"
17 using namespace clang;
18 using namespace arcmt;
22 /// Collects transformations and merges them before applying them with
23 /// with applyRewrites(). E.g. if the same source range
24 /// is requested to be removed twice, only one rewriter remove will be invoked.
25 /// Rewrites happen in "transactions"; if one rewrite in the transaction cannot
26 /// be done (e.g. it resides in a macro) all rewrites in the transaction are
28 /// FIXME: "Transactional" rewrites support should be baked in the Rewriter.
29 class TransformActionsImpl {
30 CapturedDiagList &CapturedDiags;
37 Act_Insert, Act_InsertAfterToken,
38 Act_Remove, Act_RemoveStmt,
39 Act_Replace, Act_ReplaceText,
40 Act_IncreaseIndentation,
48 StringRef Text1, Text2;
50 SmallVector<unsigned, 2> DiagIDs;
53 std::vector<ActionData> CachedActions;
55 enum RangeComparison {
64 /// A range to remove. It is a character range.
66 FullSourceLoc Begin, End;
68 CharRange(CharSourceRange range, SourceManager &srcMgr, Preprocessor &PP) {
69 SourceLocation beginLoc = range.getBegin(), endLoc = range.getEnd();
70 assert(beginLoc.isValid() && endLoc.isValid());
71 if (range.isTokenRange()) {
72 Begin = FullSourceLoc(srcMgr.getExpansionLoc(beginLoc), srcMgr);
73 End = FullSourceLoc(getLocForEndOfToken(endLoc, srcMgr, PP), srcMgr);
75 Begin = FullSourceLoc(srcMgr.getExpansionLoc(beginLoc), srcMgr);
76 End = FullSourceLoc(srcMgr.getExpansionLoc(endLoc), srcMgr);
78 assert(Begin.isValid() && End.isValid());
81 RangeComparison compareWith(const CharRange &RHS) const {
82 if (End.isBeforeInTranslationUnitThan(RHS.Begin))
84 if (RHS.End.isBeforeInTranslationUnitThan(Begin))
86 if (!Begin.isBeforeInTranslationUnitThan(RHS.Begin) &&
87 !RHS.End.isBeforeInTranslationUnitThan(End))
88 return Range_Contained;
89 if (Begin.isBeforeInTranslationUnitThan(RHS.Begin) &&
90 RHS.End.isBeforeInTranslationUnitThan(End))
91 return Range_Contains;
92 if (Begin.isBeforeInTranslationUnitThan(RHS.Begin))
93 return Range_ExtendsBegin;
95 return Range_ExtendsEnd;
98 static RangeComparison compare(SourceRange LHS, SourceRange RHS,
99 SourceManager &SrcMgr, Preprocessor &PP) {
100 return CharRange(CharSourceRange::getTokenRange(LHS), SrcMgr, PP)
101 .compareWith(CharRange(CharSourceRange::getTokenRange(RHS),
106 typedef SmallVector<StringRef, 2> TextsVec;
107 typedef std::map<FullSourceLoc, TextsVec, FullSourceLoc::BeforeThanCompare>
110 /// A list of ranges to remove. They are always sorted and they never
111 /// intersect with each other.
112 std::list<CharRange> Removals;
114 llvm::DenseSet<Stmt *> StmtRemovals;
116 std::vector<std::pair<CharRange, SourceLocation> > IndentationRanges;
118 /// Keeps text passed to transformation methods.
119 llvm::StringMap<bool> UniqueText;
122 TransformActionsImpl(CapturedDiagList &capturedDiags,
123 ASTContext &ctx, Preprocessor &PP)
124 : CapturedDiags(capturedDiags), Ctx(ctx), PP(PP), IsInTransaction(false) { }
126 ASTContext &getASTContext() { return Ctx; }
128 void startTransaction();
129 bool commitTransaction();
130 void abortTransaction();
132 bool isInTransaction() const { return IsInTransaction; }
134 void insert(SourceLocation loc, StringRef text);
135 void insertAfterToken(SourceLocation loc, StringRef text);
136 void remove(SourceRange range);
137 void removeStmt(Stmt *S);
138 void replace(SourceRange range, StringRef text);
139 void replace(SourceRange range, SourceRange replacementRange);
140 void replaceStmt(Stmt *S, StringRef text);
141 void replaceText(SourceLocation loc, StringRef text,
142 StringRef replacementText);
143 void increaseIndentation(SourceRange range,
144 SourceLocation parentIndent);
146 bool clearDiagnostic(ArrayRef<unsigned> IDs, SourceRange range);
148 void applyRewrites(TransformActions::RewriteReceiver &receiver);
151 bool canInsert(SourceLocation loc);
152 bool canInsertAfterToken(SourceLocation loc);
153 bool canRemoveRange(SourceRange range);
154 bool canReplaceRange(SourceRange range, SourceRange replacementRange);
155 bool canReplaceText(SourceLocation loc, StringRef text);
157 void commitInsert(SourceLocation loc, StringRef text);
158 void commitInsertAfterToken(SourceLocation loc, StringRef text);
159 void commitRemove(SourceRange range);
160 void commitRemoveStmt(Stmt *S);
161 void commitReplace(SourceRange range, SourceRange replacementRange);
162 void commitReplaceText(SourceLocation loc, StringRef text,
163 StringRef replacementText);
164 void commitIncreaseIndentation(SourceRange range,SourceLocation parentIndent);
165 void commitClearDiagnostic(ArrayRef<unsigned> IDs, SourceRange range);
167 void addRemoval(CharSourceRange range);
168 void addInsertion(SourceLocation loc, StringRef text);
170 /// Stores text passed to the transformation methods to keep the string
171 /// "alive". Since the vast majority of text will be the same, we also unique
172 /// the strings using a StringMap.
173 StringRef getUniqueText(StringRef text);
175 /// Computes the source location just past the end of the token at
176 /// the given source location. If the location points at a macro, the whole
177 /// macro expansion is skipped.
178 static SourceLocation getLocForEndOfToken(SourceLocation loc,
179 SourceManager &SM,Preprocessor &PP);
182 } // anonymous namespace
184 void TransformActionsImpl::startTransaction() {
185 assert(!IsInTransaction &&
186 "Cannot start a transaction in the middle of another one");
187 IsInTransaction = true;
190 bool TransformActionsImpl::commitTransaction() {
191 assert(IsInTransaction && "No transaction started");
193 if (CachedActions.empty()) {
194 IsInTransaction = false;
198 // Verify that all actions are possible otherwise abort the whole transaction.
199 bool AllActionsPossible = true;
200 for (unsigned i = 0, e = CachedActions.size(); i != e; ++i) {
201 ActionData &act = CachedActions[i];
204 if (!canInsert(act.Loc))
205 AllActionsPossible = false;
207 case Act_InsertAfterToken:
208 if (!canInsertAfterToken(act.Loc))
209 AllActionsPossible = false;
212 if (!canRemoveRange(act.R1))
213 AllActionsPossible = false;
217 if (!canRemoveRange(act.S->getSourceRange()))
218 AllActionsPossible = false;
221 if (!canReplaceRange(act.R1, act.R2))
222 AllActionsPossible = false;
224 case Act_ReplaceText:
225 if (!canReplaceText(act.Loc, act.Text1))
226 AllActionsPossible = false;
228 case Act_IncreaseIndentation:
229 // This is not important, we don't care if it will fail.
231 case Act_ClearDiagnostic:
232 // We are just checking source rewrites.
235 if (!AllActionsPossible)
239 if (!AllActionsPossible) {
244 for (unsigned i = 0, e = CachedActions.size(); i != e; ++i) {
245 ActionData &act = CachedActions[i];
248 commitInsert(act.Loc, act.Text1);
250 case Act_InsertAfterToken:
251 commitInsertAfterToken(act.Loc, act.Text1);
254 commitRemove(act.R1);
257 commitRemoveStmt(act.S);
260 commitReplace(act.R1, act.R2);
262 case Act_ReplaceText:
263 commitReplaceText(act.Loc, act.Text1, act.Text2);
265 case Act_IncreaseIndentation:
266 commitIncreaseIndentation(act.R1, act.Loc);
268 case Act_ClearDiagnostic:
269 commitClearDiagnostic(act.DiagIDs, act.R1);
274 CachedActions.clear();
275 IsInTransaction = false;
279 void TransformActionsImpl::abortTransaction() {
280 assert(IsInTransaction && "No transaction started");
281 CachedActions.clear();
282 IsInTransaction = false;
285 void TransformActionsImpl::insert(SourceLocation loc, StringRef text) {
286 assert(IsInTransaction && "Actions only allowed during a transaction");
287 text = getUniqueText(text);
289 data.Kind = Act_Insert;
292 CachedActions.push_back(data);
295 void TransformActionsImpl::insertAfterToken(SourceLocation loc, StringRef text) {
296 assert(IsInTransaction && "Actions only allowed during a transaction");
297 text = getUniqueText(text);
299 data.Kind = Act_InsertAfterToken;
302 CachedActions.push_back(data);
305 void TransformActionsImpl::remove(SourceRange range) {
306 assert(IsInTransaction && "Actions only allowed during a transaction");
308 data.Kind = Act_Remove;
310 CachedActions.push_back(data);
313 void TransformActionsImpl::removeStmt(Stmt *S) {
314 assert(IsInTransaction && "Actions only allowed during a transaction");
316 data.Kind = Act_RemoveStmt;
317 data.S = S->IgnoreImplicit(); // important for uniquing
318 CachedActions.push_back(data);
321 void TransformActionsImpl::replace(SourceRange range, StringRef text) {
322 assert(IsInTransaction && "Actions only allowed during a transaction");
323 text = getUniqueText(text);
325 insert(range.getBegin(), text);
328 void TransformActionsImpl::replace(SourceRange range,
329 SourceRange replacementRange) {
330 assert(IsInTransaction && "Actions only allowed during a transaction");
332 data.Kind = Act_Replace;
334 data.R2 = replacementRange;
335 CachedActions.push_back(data);
338 void TransformActionsImpl::replaceText(SourceLocation loc, StringRef text,
339 StringRef replacementText) {
340 text = getUniqueText(text);
341 replacementText = getUniqueText(replacementText);
343 data.Kind = Act_ReplaceText;
346 data.Text2 = replacementText;
347 CachedActions.push_back(data);
350 void TransformActionsImpl::replaceStmt(Stmt *S, StringRef text) {
351 assert(IsInTransaction && "Actions only allowed during a transaction");
352 text = getUniqueText(text);
353 insert(S->getLocStart(), text);
357 void TransformActionsImpl::increaseIndentation(SourceRange range,
358 SourceLocation parentIndent) {
359 if (range.isInvalid()) return;
360 assert(IsInTransaction && "Actions only allowed during a transaction");
362 data.Kind = Act_IncreaseIndentation;
364 data.Loc = parentIndent;
365 CachedActions.push_back(data);
368 bool TransformActionsImpl::clearDiagnostic(ArrayRef<unsigned> IDs,
370 assert(IsInTransaction && "Actions only allowed during a transaction");
371 if (!CapturedDiags.hasDiagnostic(IDs, range))
375 data.Kind = Act_ClearDiagnostic;
377 data.DiagIDs.append(IDs.begin(), IDs.end());
378 CachedActions.push_back(data);
382 bool TransformActionsImpl::canInsert(SourceLocation loc) {
386 SourceManager &SM = Ctx.getSourceManager();
387 if (SM.isInSystemHeader(SM.getExpansionLoc(loc)))
392 return PP.isAtStartOfMacroExpansion(loc);
395 bool TransformActionsImpl::canInsertAfterToken(SourceLocation loc) {
399 SourceManager &SM = Ctx.getSourceManager();
400 if (SM.isInSystemHeader(SM.getExpansionLoc(loc)))
405 return PP.isAtEndOfMacroExpansion(loc);
408 bool TransformActionsImpl::canRemoveRange(SourceRange range) {
409 return canInsert(range.getBegin()) && canInsertAfterToken(range.getEnd());
412 bool TransformActionsImpl::canReplaceRange(SourceRange range,
413 SourceRange replacementRange) {
414 return canRemoveRange(range) && canRemoveRange(replacementRange);
417 bool TransformActionsImpl::canReplaceText(SourceLocation loc, StringRef text) {
421 SourceManager &SM = Ctx.getSourceManager();
422 loc = SM.getExpansionLoc(loc);
424 // Break down the source location.
425 std::pair<FileID, unsigned> locInfo = SM.getDecomposedLoc(loc);
427 // Try to load the file buffer.
428 bool invalidTemp = false;
429 StringRef file = SM.getBufferData(locInfo.first, &invalidTemp);
433 return file.substr(locInfo.second).startswith(text);
436 void TransformActionsImpl::commitInsert(SourceLocation loc, StringRef text) {
437 addInsertion(loc, text);
440 void TransformActionsImpl::commitInsertAfterToken(SourceLocation loc,
442 addInsertion(getLocForEndOfToken(loc, Ctx.getSourceManager(), PP), text);
445 void TransformActionsImpl::commitRemove(SourceRange range) {
446 addRemoval(CharSourceRange::getTokenRange(range));
449 void TransformActionsImpl::commitRemoveStmt(Stmt *S) {
451 if (StmtRemovals.count(S))
452 return; // already removed.
454 if (Expr *E = dyn_cast<Expr>(S)) {
455 commitRemove(E->getSourceRange());
456 commitInsert(E->getSourceRange().getBegin(), getARCMTMacroName());
458 commitRemove(S->getSourceRange());
460 StmtRemovals.insert(S);
463 void TransformActionsImpl::commitReplace(SourceRange range,
464 SourceRange replacementRange) {
465 RangeComparison comp = CharRange::compare(replacementRange, range,
466 Ctx.getSourceManager(), PP);
467 assert(comp == Range_Contained);
468 if (comp != Range_Contained)
469 return; // Although we asserted, be extra safe for release build.
470 if (range.getBegin() != replacementRange.getBegin())
471 addRemoval(CharSourceRange::getCharRange(range.getBegin(),
472 replacementRange.getBegin()));
473 if (replacementRange.getEnd() != range.getEnd())
474 addRemoval(CharSourceRange::getTokenRange(
475 getLocForEndOfToken(replacementRange.getEnd(),
476 Ctx.getSourceManager(), PP),
479 void TransformActionsImpl::commitReplaceText(SourceLocation loc,
481 StringRef replacementText) {
482 SourceManager &SM = Ctx.getSourceManager();
483 loc = SM.getExpansionLoc(loc);
484 // canReplaceText already checked if loc points at text.
485 SourceLocation afterText = loc.getLocWithOffset(text.size());
487 addRemoval(CharSourceRange::getCharRange(loc, afterText));
488 commitInsert(loc, replacementText);
491 void TransformActionsImpl::commitIncreaseIndentation(SourceRange range,
492 SourceLocation parentIndent) {
493 SourceManager &SM = Ctx.getSourceManager();
494 IndentationRanges.push_back(
495 std::make_pair(CharRange(CharSourceRange::getTokenRange(range),
497 SM.getExpansionLoc(parentIndent)));
500 void TransformActionsImpl::commitClearDiagnostic(ArrayRef<unsigned> IDs,
502 CapturedDiags.clearDiagnostic(IDs, range);
505 void TransformActionsImpl::addInsertion(SourceLocation loc, StringRef text) {
506 SourceManager &SM = Ctx.getSourceManager();
507 loc = SM.getExpansionLoc(loc);
508 for (const CharRange &I : llvm::reverse(Removals)) {
509 if (!SM.isBeforeInTranslationUnit(loc, I.End))
511 if (I.Begin.isBeforeInTranslationUnitThan(loc))
515 Inserts[FullSourceLoc(loc, SM)].push_back(text);
518 void TransformActionsImpl::addRemoval(CharSourceRange range) {
519 CharRange newRange(range, Ctx.getSourceManager(), PP);
520 if (newRange.Begin == newRange.End)
523 Inserts.erase(Inserts.upper_bound(newRange.Begin),
524 Inserts.lower_bound(newRange.End));
526 std::list<CharRange>::iterator I = Removals.end();
527 while (I != Removals.begin()) {
528 std::list<CharRange>::iterator RI = I;
530 RangeComparison comp = newRange.compareWith(*RI);
536 Removals.insert(I, newRange);
538 case Range_Contained:
541 RI->End = newRange.End;
543 case Range_ExtendsBegin:
544 newRange.End = RI->End;
547 case Range_ExtendsEnd:
548 RI->End = newRange.End;
553 Removals.insert(Removals.begin(), newRange);
556 void TransformActionsImpl::applyRewrites(
557 TransformActions::RewriteReceiver &receiver) {
558 for (InsertsMap::iterator I = Inserts.begin(), E = Inserts.end(); I!=E; ++I) {
559 SourceLocation loc = I->first;
560 for (TextsVec::iterator
561 TI = I->second.begin(), TE = I->second.end(); TI != TE; ++TI) {
562 receiver.insert(loc, *TI);
566 for (std::vector<std::pair<CharRange, SourceLocation> >::iterator
567 I = IndentationRanges.begin(), E = IndentationRanges.end(); I!=E; ++I) {
568 CharSourceRange range = CharSourceRange::getCharRange(I->first.Begin,
570 receiver.increaseIndentation(range, I->second);
573 for (std::list<CharRange>::iterator
574 I = Removals.begin(), E = Removals.end(); I != E; ++I) {
575 CharSourceRange range = CharSourceRange::getCharRange(I->Begin, I->End);
576 receiver.remove(range);
580 /// Stores text passed to the transformation methods to keep the string
581 /// "alive". Since the vast majority of text will be the same, we also unique
582 /// the strings using a StringMap.
583 StringRef TransformActionsImpl::getUniqueText(StringRef text) {
584 return UniqueText.insert(std::make_pair(text, false)).first->first();
587 /// Computes the source location just past the end of the token at
588 /// the given source location. If the location points at a macro, the whole
589 /// macro expansion is skipped.
590 SourceLocation TransformActionsImpl::getLocForEndOfToken(SourceLocation loc,
593 if (loc.isMacroID()) {
594 CharSourceRange Exp = SM.getExpansionRange(loc);
595 if (Exp.isCharRange())
599 return PP.getLocForEndOfToken(loc);
602 TransformActions::RewriteReceiver::~RewriteReceiver() { }
604 TransformActions::TransformActions(DiagnosticsEngine &diag,
605 CapturedDiagList &capturedDiags,
606 ASTContext &ctx, Preprocessor &PP)
607 : Diags(diag), CapturedDiags(capturedDiags) {
608 Impl = new TransformActionsImpl(capturedDiags, ctx, PP);
611 TransformActions::~TransformActions() {
612 delete static_cast<TransformActionsImpl*>(Impl);
615 void TransformActions::startTransaction() {
616 static_cast<TransformActionsImpl*>(Impl)->startTransaction();
619 bool TransformActions::commitTransaction() {
620 return static_cast<TransformActionsImpl*>(Impl)->commitTransaction();
623 void TransformActions::abortTransaction() {
624 static_cast<TransformActionsImpl*>(Impl)->abortTransaction();
628 void TransformActions::insert(SourceLocation loc, StringRef text) {
629 static_cast<TransformActionsImpl*>(Impl)->insert(loc, text);
632 void TransformActions::insertAfterToken(SourceLocation loc,
634 static_cast<TransformActionsImpl*>(Impl)->insertAfterToken(loc, text);
637 void TransformActions::remove(SourceRange range) {
638 static_cast<TransformActionsImpl*>(Impl)->remove(range);
641 void TransformActions::removeStmt(Stmt *S) {
642 static_cast<TransformActionsImpl*>(Impl)->removeStmt(S);
645 void TransformActions::replace(SourceRange range, StringRef text) {
646 static_cast<TransformActionsImpl*>(Impl)->replace(range, text);
649 void TransformActions::replace(SourceRange range,
650 SourceRange replacementRange) {
651 static_cast<TransformActionsImpl*>(Impl)->replace(range, replacementRange);
654 void TransformActions::replaceStmt(Stmt *S, StringRef text) {
655 static_cast<TransformActionsImpl*>(Impl)->replaceStmt(S, text);
658 void TransformActions::replaceText(SourceLocation loc, StringRef text,
659 StringRef replacementText) {
660 static_cast<TransformActionsImpl*>(Impl)->replaceText(loc, text,
664 void TransformActions::increaseIndentation(SourceRange range,
665 SourceLocation parentIndent) {
666 static_cast<TransformActionsImpl*>(Impl)->increaseIndentation(range,
670 bool TransformActions::clearDiagnostic(ArrayRef<unsigned> IDs,
672 return static_cast<TransformActionsImpl*>(Impl)->clearDiagnostic(IDs, range);
675 void TransformActions::applyRewrites(RewriteReceiver &receiver) {
676 static_cast<TransformActionsImpl*>(Impl)->applyRewrites(receiver);
679 DiagnosticBuilder TransformActions::report(SourceLocation loc, unsigned diagId,
681 assert(!static_cast<TransformActionsImpl *>(Impl)->isInTransaction() &&
682 "Errors should be emitted out of a transaction");
683 return Diags.Report(loc, diagId) << range;
686 void TransformActions::reportError(StringRef message, SourceLocation loc,
688 report(loc, diag::err_mt_message, range) << message;
691 void TransformActions::reportWarning(StringRef message, SourceLocation loc,
693 report(loc, diag::warn_mt_message, range) << message;
696 void TransformActions::reportNote(StringRef message, SourceLocation loc,
698 report(loc, diag::note_mt_message, range) << message;