xref: /freebsd/contrib/llvm-project/clang/lib/Tooling/Refactoring.cpp (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1*0b57cec5SDimitry Andric //===--- Refactoring.cpp - Framework for clang refactoring tools ----------===//
2*0b57cec5SDimitry Andric //
3*0b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*0b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*0b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*0b57cec5SDimitry Andric //
7*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
8*0b57cec5SDimitry Andric //
9*0b57cec5SDimitry Andric //  Implements tools to support refactorings.
10*0b57cec5SDimitry Andric //
11*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
12*0b57cec5SDimitry Andric 
13*0b57cec5SDimitry Andric #include "clang/Tooling/Refactoring.h"
14*0b57cec5SDimitry Andric #include "clang/Basic/DiagnosticOptions.h"
15*0b57cec5SDimitry Andric #include "clang/Basic/FileManager.h"
16*0b57cec5SDimitry Andric #include "clang/Basic/SourceManager.h"
17*0b57cec5SDimitry Andric #include "clang/Format/Format.h"
18*0b57cec5SDimitry Andric #include "clang/Frontend/TextDiagnosticPrinter.h"
19*0b57cec5SDimitry Andric #include "clang/Lex/Lexer.h"
20*0b57cec5SDimitry Andric #include "clang/Rewrite/Core/Rewriter.h"
21*0b57cec5SDimitry Andric #include "llvm/Support/Path.h"
22*0b57cec5SDimitry Andric #include "llvm/Support/raw_os_ostream.h"
23*0b57cec5SDimitry Andric 
24*0b57cec5SDimitry Andric namespace clang {
25*0b57cec5SDimitry Andric namespace tooling {
26*0b57cec5SDimitry Andric 
27*0b57cec5SDimitry Andric RefactoringTool::RefactoringTool(
28*0b57cec5SDimitry Andric     const CompilationDatabase &Compilations, ArrayRef<std::string> SourcePaths,
29*0b57cec5SDimitry Andric     std::shared_ptr<PCHContainerOperations> PCHContainerOps)
30*0b57cec5SDimitry Andric     : ClangTool(Compilations, SourcePaths, std::move(PCHContainerOps)) {}
31*0b57cec5SDimitry Andric 
32*0b57cec5SDimitry Andric std::map<std::string, Replacements> &RefactoringTool::getReplacements() {
33*0b57cec5SDimitry Andric   return FileToReplaces;
34*0b57cec5SDimitry Andric }
35*0b57cec5SDimitry Andric 
36*0b57cec5SDimitry Andric int RefactoringTool::runAndSave(FrontendActionFactory *ActionFactory) {
37*0b57cec5SDimitry Andric   if (int Result = run(ActionFactory)) {
38*0b57cec5SDimitry Andric     return Result;
39*0b57cec5SDimitry Andric   }
40*0b57cec5SDimitry Andric 
41*0b57cec5SDimitry Andric   LangOptions DefaultLangOptions;
42*0b57cec5SDimitry Andric   IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions();
43*0b57cec5SDimitry Andric   TextDiagnosticPrinter DiagnosticPrinter(llvm::errs(), &*DiagOpts);
44*0b57cec5SDimitry Andric   DiagnosticsEngine Diagnostics(
45*0b57cec5SDimitry Andric       IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs()),
46*0b57cec5SDimitry Andric       &*DiagOpts, &DiagnosticPrinter, false);
47*0b57cec5SDimitry Andric   SourceManager Sources(Diagnostics, getFiles());
48*0b57cec5SDimitry Andric   Rewriter Rewrite(Sources, DefaultLangOptions);
49*0b57cec5SDimitry Andric 
50*0b57cec5SDimitry Andric   if (!applyAllReplacements(Rewrite)) {
51*0b57cec5SDimitry Andric     llvm::errs() << "Skipped some replacements.\n";
52*0b57cec5SDimitry Andric   }
53*0b57cec5SDimitry Andric 
54*0b57cec5SDimitry Andric   return saveRewrittenFiles(Rewrite);
55*0b57cec5SDimitry Andric }
56*0b57cec5SDimitry Andric 
57*0b57cec5SDimitry Andric bool RefactoringTool::applyAllReplacements(Rewriter &Rewrite) {
58*0b57cec5SDimitry Andric   bool Result = true;
59*0b57cec5SDimitry Andric   for (const auto &Entry : groupReplacementsByFile(
60*0b57cec5SDimitry Andric            Rewrite.getSourceMgr().getFileManager(), FileToReplaces))
61*0b57cec5SDimitry Andric     Result = tooling::applyAllReplacements(Entry.second, Rewrite) && Result;
62*0b57cec5SDimitry Andric   return Result;
63*0b57cec5SDimitry Andric }
64*0b57cec5SDimitry Andric 
65*0b57cec5SDimitry Andric int RefactoringTool::saveRewrittenFiles(Rewriter &Rewrite) {
66*0b57cec5SDimitry Andric   return Rewrite.overwriteChangedFiles() ? 1 : 0;
67*0b57cec5SDimitry Andric }
68*0b57cec5SDimitry Andric 
69*0b57cec5SDimitry Andric bool formatAndApplyAllReplacements(
70*0b57cec5SDimitry Andric     const std::map<std::string, Replacements> &FileToReplaces,
71*0b57cec5SDimitry Andric     Rewriter &Rewrite, StringRef Style) {
72*0b57cec5SDimitry Andric   SourceManager &SM = Rewrite.getSourceMgr();
73*0b57cec5SDimitry Andric   FileManager &Files = SM.getFileManager();
74*0b57cec5SDimitry Andric 
75*0b57cec5SDimitry Andric   bool Result = true;
76*0b57cec5SDimitry Andric   for (const auto &FileAndReplaces : groupReplacementsByFile(
77*0b57cec5SDimitry Andric            Rewrite.getSourceMgr().getFileManager(), FileToReplaces)) {
78*0b57cec5SDimitry Andric     const std::string &FilePath = FileAndReplaces.first;
79*0b57cec5SDimitry Andric     auto &CurReplaces = FileAndReplaces.second;
80*0b57cec5SDimitry Andric 
81*0b57cec5SDimitry Andric     const FileEntry *Entry = Files.getFile(FilePath);
82*0b57cec5SDimitry Andric     FileID ID = SM.getOrCreateFileID(Entry, SrcMgr::C_User);
83*0b57cec5SDimitry Andric     StringRef Code = SM.getBufferData(ID);
84*0b57cec5SDimitry Andric 
85*0b57cec5SDimitry Andric     auto CurStyle = format::getStyle(Style, FilePath, "LLVM");
86*0b57cec5SDimitry Andric     if (!CurStyle) {
87*0b57cec5SDimitry Andric       llvm::errs() << llvm::toString(CurStyle.takeError()) << "\n";
88*0b57cec5SDimitry Andric       return false;
89*0b57cec5SDimitry Andric     }
90*0b57cec5SDimitry Andric 
91*0b57cec5SDimitry Andric     auto NewReplacements =
92*0b57cec5SDimitry Andric         format::formatReplacements(Code, CurReplaces, *CurStyle);
93*0b57cec5SDimitry Andric     if (!NewReplacements) {
94*0b57cec5SDimitry Andric       llvm::errs() << llvm::toString(NewReplacements.takeError()) << "\n";
95*0b57cec5SDimitry Andric       return false;
96*0b57cec5SDimitry Andric     }
97*0b57cec5SDimitry Andric     Result = applyAllReplacements(*NewReplacements, Rewrite) && Result;
98*0b57cec5SDimitry Andric   }
99*0b57cec5SDimitry Andric   return Result;
100*0b57cec5SDimitry Andric }
101*0b57cec5SDimitry Andric 
102*0b57cec5SDimitry Andric } // end namespace tooling
103*0b57cec5SDimitry Andric } // end namespace clang
104