1 //===--- ObjCMT.cpp - ObjC Migrate Tool -----------------------------------===//
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 "clang/ARCMigrate/ARCMTActions.h"
11 #include "clang/Frontend/CompilerInstance.h"
12 #include "clang/Frontend/MultiplexConsumer.h"
13 #include "clang/AST/RecursiveASTVisitor.h"
14 #include "clang/AST/NSAPI.h"
15 #include "clang/AST/ASTConsumer.h"
16 #include "clang/Edit/Rewriters.h"
17 #include "clang/Edit/EditedSource.h"
18 #include "clang/Edit/Commit.h"
19 #include "clang/Edit/EditsReceiver.h"
20 #include "clang/Rewrite/Rewriter.h"
21 #include "clang/Lex/Preprocessor.h"
22 #include "clang/Basic/FileManager.h"
23 #include "llvm/ADT/SmallString.h"
25 using namespace clang;
26 using namespace arcmt;
30 class ObjCMigrateASTConsumer : public ASTConsumer {
31 void migrateDecl(Decl *D);
34 std::string MigrateDir;
36 bool MigrateSubscripting;
37 llvm::OwningPtr<NSAPI> NSAPIObj;
38 llvm::OwningPtr<edit::EditedSource> Editor;
39 FileRemapper &Remapper;
41 const PreprocessingRecord *PPRec;
44 ObjCMigrateASTConsumer(StringRef migrateDir,
46 bool migrateSubscripting,
47 FileRemapper &remapper,
49 const PreprocessingRecord *PPRec,
50 bool isOutputFile = false)
51 : MigrateDir(migrateDir),
52 MigrateLiterals(migrateLiterals),
53 MigrateSubscripting(migrateSubscripting),
54 Remapper(remapper), FileMgr(fileMgr), PPRec(PPRec),
55 IsOutputFile(isOutputFile) { }
58 virtual void Initialize(ASTContext &Context) {
59 NSAPIObj.reset(new NSAPI(Context));
60 Editor.reset(new edit::EditedSource(Context.getSourceManager(),
61 Context.getLangOpts(),
65 virtual bool HandleTopLevelDecl(DeclGroupRef DG) {
66 for (DeclGroupRef::iterator I = DG.begin(), E = DG.end(); I != E; ++I)
70 virtual void HandleInterestingDecl(DeclGroupRef DG) {
71 // Ignore decls from the PCH.
73 virtual void HandleTopLevelDeclInObjCContainer(DeclGroupRef DG) {
74 ObjCMigrateASTConsumer::HandleTopLevelDecl(DG);
77 virtual void HandleTranslationUnit(ASTContext &Ctx);
82 ObjCMigrateAction::ObjCMigrateAction(FrontendAction *WrappedAction,
85 bool migrateSubscripting)
86 : WrapperFrontendAction(WrappedAction), MigrateDir(migrateDir),
87 MigrateLiterals(migrateLiterals), MigrateSubscripting(migrateSubscripting),
89 if (MigrateDir.empty())
90 MigrateDir = "."; // user current directory if none is given.
93 ASTConsumer *ObjCMigrateAction::CreateASTConsumer(CompilerInstance &CI,
96 WrappedConsumer = WrapperFrontendAction::CreateASTConsumer(CI, InFile);
97 ASTConsumer *MTConsumer = new ObjCMigrateASTConsumer(MigrateDir,
101 CompInst->getFileManager(),
102 CompInst->getPreprocessor().getPreprocessingRecord());
103 ASTConsumer *Consumers[] = { MTConsumer, WrappedConsumer };
104 return new MultiplexConsumer(Consumers);
107 bool ObjCMigrateAction::BeginInvocation(CompilerInstance &CI) {
108 Remapper.initFromDisk(MigrateDir, CI.getDiagnostics(),
109 /*ignoreIfFilesChanges=*/true);
111 CI.getDiagnostics().setIgnoreAllWarnings(true);
112 CI.getPreprocessorOpts().DetailedRecord = true;
113 CI.getPreprocessorOpts().DetailedRecordConditionalDirectives = true;
118 class ObjCMigrator : public RecursiveASTVisitor<ObjCMigrator> {
119 ObjCMigrateASTConsumer &Consumer;
122 ObjCMigrator(ObjCMigrateASTConsumer &consumer) : Consumer(consumer) { }
124 bool shouldVisitTemplateInstantiations() const { return false; }
125 bool shouldWalkTypesOfTypeLocs() const { return false; }
127 bool VisitObjCMessageExpr(ObjCMessageExpr *E) {
128 if (Consumer.MigrateLiterals) {
129 edit::Commit commit(*Consumer.Editor);
130 edit::rewriteToObjCLiteralSyntax(E, *Consumer.NSAPIObj, commit);
131 Consumer.Editor->commit(commit);
134 if (Consumer.MigrateSubscripting) {
135 edit::Commit commit(*Consumer.Editor);
136 edit::rewriteToObjCSubscriptSyntax(E, *Consumer.NSAPIObj, commit);
137 Consumer.Editor->commit(commit);
143 bool TraverseObjCMessageExpr(ObjCMessageExpr *E) {
144 // Do depth first; we want to rewrite the subexpressions first so that if
145 // we have to move expressions we will move them already rewritten.
146 for (Stmt::child_range range = E->children(); range; ++range)
147 if (!TraverseStmt(*range))
150 return WalkUpFromObjCMessageExpr(E);
155 void ObjCMigrateASTConsumer::migrateDecl(Decl *D) {
158 if (isa<ObjCMethodDecl>(D))
159 return; // Wait for the ObjC container declaration.
161 ObjCMigrator(*this).TraverseDecl(D);
166 class RewritesReceiver : public edit::EditsReceiver {
170 RewritesReceiver(Rewriter &Rewrite) : Rewrite(Rewrite) { }
172 virtual void insert(SourceLocation loc, StringRef text) {
173 Rewrite.InsertText(loc, text);
175 virtual void replace(CharSourceRange range, StringRef text) {
176 Rewrite.ReplaceText(range.getBegin(), Rewrite.getRangeSize(range), text);
182 void ObjCMigrateASTConsumer::HandleTranslationUnit(ASTContext &Ctx) {
183 Rewriter rewriter(Ctx.getSourceManager(), Ctx.getLangOpts());
184 RewritesReceiver Rec(rewriter);
185 Editor->applyRewrites(Rec);
187 for (Rewriter::buffer_iterator
188 I = rewriter.buffer_begin(), E = rewriter.buffer_end(); I != E; ++I) {
189 FileID FID = I->first;
190 RewriteBuffer &buf = I->second;
191 const FileEntry *file = Ctx.getSourceManager().getFileEntryForID(FID);
193 llvm::SmallString<512> newText;
194 llvm::raw_svector_ostream vecOS(newText);
197 llvm::MemoryBuffer *memBuf = llvm::MemoryBuffer::getMemBufferCopy(
198 StringRef(newText.data(), newText.size()), file->getName());
199 llvm::SmallString<64> filePath(file->getName());
200 FileMgr.FixupRelativePath(filePath);
201 Remapper.remap(filePath.str(), memBuf);
205 Remapper.flushToFile(MigrateDir, Ctx.getDiagnostics());
207 Remapper.flushToDisk(MigrateDir, Ctx.getDiagnostics());
211 bool MigrateSourceAction::BeginInvocation(CompilerInstance &CI) {
212 CI.getPreprocessorOpts().DetailedRecord = true;
213 CI.getPreprocessorOpts().DetailedRecordConditionalDirectives = true;
217 ASTConsumer *MigrateSourceAction::CreateASTConsumer(CompilerInstance &CI,
219 return new ObjCMigrateASTConsumer(CI.getFrontendOpts().OutputFile,
220 /*MigrateLiterals=*/true,
221 /*MigrateSubscripting=*/true,
224 CI.getPreprocessor().getPreprocessingRecord(),
225 /*isOutputFile=*/true);