17 #include "clang/Basic/Diagnostic.h"
18 #include "clang/Basic/DiagnosticOptions.h"
19 #include "clang/Basic/SourceManager.h"
20 #include "clang/Basic/Version.h"
21 #include "clang/Format/Format.h"
22 #include "clang/Rewrite/Core/Rewriter.h"
23 #include "llvm/ADT/STLExtras.h"
24 #include "llvm/ADT/StringSet.h"
25 #include "llvm/Support/CommandLine.h"
28 using namespace clang;
29 using namespace clang::replace;
31 static cl::opt<std::string>
Directory(cl::Positional, cl::Required,
32 cl::desc(
"<Search Root Directory>"));
41 "remove-change-desc-files",
42 cl::desc(
"Remove the change description files regardless of successful\n"
43 "merging/replacing."),
49 cl::desc(
"Enable formatting of code changed by applying replacements.\n"
50 "Use -style to choose formatting style.\n"),
60 cl::desc(
"Path to a directory containing a .clang-format file\n"
61 "describing a formatting style to use for formatting\n"
62 "code when -style=file.\n"),
65 static cl::opt<std::string>
66 FormatStyleOpt(
"style", cl::desc(format::StyleOptionHelpDescription),
72 class ScopedFileRemover {
75 clang::DiagnosticsEngine &Diagnostics)
76 : TURFiles(Files), Diag(Diagnostics) {}
78 ~ScopedFileRemover() {
84 clang::DiagnosticsEngine &Diag;
89 outs() <<
"clang-apply-replacements version " CLANG_VERSION_STRING <<
"\n";
108 Rewriter &Rewrites, std::string &
Result) {
109 if (Replacements.empty())
return true;
111 if (!tooling::applyAllReplacements(Replacements, Rewrites))
114 SourceManager &
SM = Rewrites.getSourceMgr();
115 FileManager &
Files = SM.getFileManager();
117 StringRef FileName = Replacements.begin()->getFilePath();
118 const clang::FileEntry *
Entry = Files.getFile(FileName);
119 assert(Entry &&
"Expected an existing file");
120 FileID ID = SM.translateFile(Entry);
121 assert(ID.isValid() &&
"Expected a valid FileID");
122 const RewriteBuffer *Buffer = Rewrites.getRewriteBufferFor(ID);
123 Result = std::string(Buffer->begin(), Buffer->end());
143 std::string &
Result, DiagnosticsEngine &Diagnostics) {
144 FileManager
Files((FileSystemOptions()));
145 SourceManager
SM(Diagnostics, Files);
146 Rewriter Rewrites(SM, LangOptions());
171 const StringRef FileData, std::string &FormattedFileData,
172 const format::FormatStyle &FormatStyle,
173 DiagnosticsEngine &Diagnostics) {
174 assert(!Replacements.empty() &&
"Need at least one replacement");
178 StringRef FileName = Replacements.begin()->getFilePath();
179 tooling::Replacements R =
180 format::reformat(FormatStyle, FileData, Ranges, FileName);
184 std::vector<tooling::Replacement> FormattingReplacements;
185 std::copy(R.begin(), R.end(), back_inserter(FormattingReplacements));
187 if (FormattingReplacements.empty()) {
188 FormattedFileData = FileData;
192 FileManager
Files((FileSystemOptions()));
193 SourceManager
SM(Diagnostics, Files);
194 SM.overrideFileContents(Files.getFile(FileName),
195 llvm::MemoryBuffer::getMemBufferCopy(FileData));
196 Rewriter Rewrites(SM, LangOptions());
198 return getRewrittenData(FormattingReplacements, Rewrites, FormattedFileData);
201 int main(
int argc,
char **argv) {
205 cl::ParseCommandLineOptions(argc, argv);
207 IntrusiveRefCntPtr<DiagnosticOptions>
DiagOpts(
new DiagnosticOptions());
208 DiagnosticsEngine Diagnostics(
209 IntrusiveRefCntPtr<DiagnosticIDs>(
new DiagnosticIDs()),
213 format::FormatStyle FormatStyle;
220 std::error_code ErrorCode =
224 errs() <<
"Trouble iterating over directory '" <<
Directory
225 <<
"': " << ErrorCode.message() <<
"\n";
231 std::unique_ptr<ScopedFileRemover> Remover;
233 Remover.reset(
new ScopedFileRemover(TURFiles, Diagnostics));
235 FileManager
Files((FileSystemOptions()));
236 SourceManager
SM(Diagnostics, Files);
242 Rewriter ReplacementsRewriter(SM, LangOptions());
244 for (
const auto &FileAndReplacements : GroupedReplacements) {
247 if (FileAndReplacements.second.empty())
250 std::string NewFileData;
251 const char *FileName = FileAndReplacements.first->getName();
254 errs() <<
"Failed to apply replacements to " << FileName <<
"\n";
261 FormatStyle, Diagnostics)) {
262 errs() <<
"Failed to apply reformatting replacements for " << FileName
269 llvm::raw_fd_ostream FileStream(FileName, EC, llvm::sys::fs::F_None);
271 llvm::errs() <<
"Could not open " << FileName <<
" for writing\n";
275 FileStream << NewFileData;
llvm::DenseMap< const clang::FileEntry *, std::vector< clang::tooling::Replacement > > FileToReplacementsMap
Map mapping file name to Replacements targeting that file.
bool deleteReplacementFiles(const TUReplacementFiles &Files, clang::DiagnosticsEngine &Diagnostics)
Delete the replacement files.
static bool applyFormatting(const std::vector< tooling::Replacement > &Replacements, const StringRef FileData, std::string &FormattedFileData, const format::FormatStyle &FormatStyle, DiagnosticsEngine &Diagnostics)
Apply code formatting to all places where replacements were made.
static cl::opt< std::string > FormatStyleConfig("style-config", cl::desc("Path to a directory containing a .clang-format file\n""describing a formatting style to use for formatting\n""code when -style=file.\n"), cl::init(""), cl::cat(FormattingCategory))
static cl::OptionCategory FormattingCategory("Formatting Options")
std::vector< clang::tooling::TranslationUnitReplacements > TUReplacements
Collection of TranslationUnitReplacements.
static void printVersion()
std::error_code collectReplacementsFromDirectory(const llvm::StringRef Directory, TUReplacements &TUs, TUReplacementFiles &TURFiles, clang::DiagnosticsEngine &Diagnostics)
Recursively descends through a directory structure rooted at Directory and attempts to deserialize *...
static cl::opt< std::string > Directory(cl::Positional, cl::Required, cl::desc("<Search Root Directory>"))
std::vector< clang::tooling::Range > RangeVector
Collection of source ranges.
RangeVector calculateChangedRanges(const std::vector< clang::tooling::Replacement > &Replacements)
Given a collection of Replacements for a single file, produces a list of source ranges that enclose t...
static cl::opt< bool > RemoveTUReplacementFiles("remove-change-desc-files", cl::desc("Remove the change description files regardless of successful\n""merging/replacing."), cl::init(false), cl::cat(ReplacementCategory))
static cl::OptionCategory ReplacementCategory("Replacement Options")
static cl::opt< std::string > FormatStyleOpt("style", cl::desc(format::StyleOptionHelpDescription), cl::init("LLVM"), cl::cat(FormattingCategory))
const cl::OptionCategory * VisibleCategories[]
static bool getRewrittenData(const std::vector< tooling::Replacement > &Replacements, Rewriter &Rewrites, std::string &Result)
Convenience function to get rewritten content for Filename from Rewrites.
IntrusiveRefCntPtr< DiagnosticOptions > DiagOpts
int main(int argc, char **argv)
This file provides the interface for deduplicating, detecting conflicts in, and applying collections ...
static cl::opt< bool > DoFormat("format", cl::desc("Enable formatting of code changed by applying replacements.\n""Use -style to choose formatting style.\n"), cl::cat(FormattingCategory))
std::vector< std::string > TUReplacementFiles
Collection of TranslationUnitReplacement files.
bool mergeAndDeduplicate(const TUReplacements &TUs, FileToReplacementsMap &GroupedReplacements, clang::SourceManager &SM)
Deduplicate, check for conflicts, and apply all Replacements stored in TUs.
static bool applyReplacements(const std::vector< tooling::Replacement > &Replacements, std::string &Result, DiagnosticsEngine &Diagnostics)
Apply Replacements and return the new file contents.