1e5dd7070Spatrick //===- FixItRewriter.cpp - Fix-It Rewriter Diagnostic Client --------------===//
2e5dd7070Spatrick //
3e5dd7070Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4e5dd7070Spatrick // See https://llvm.org/LICENSE.txt for license information.
5e5dd7070Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6e5dd7070Spatrick //
7e5dd7070Spatrick //===----------------------------------------------------------------------===//
8e5dd7070Spatrick //
9e5dd7070Spatrick // This is a diagnostic client adaptor that performs rewrites as
10e5dd7070Spatrick // suggested by code modification hints attached to diagnostics. It
11e5dd7070Spatrick // then forwards any diagnostics to the adapted diagnostic client.
12e5dd7070Spatrick //
13e5dd7070Spatrick //===----------------------------------------------------------------------===//
14e5dd7070Spatrick
15e5dd7070Spatrick #include "clang/Rewrite/Frontend/FixItRewriter.h"
16e5dd7070Spatrick #include "clang/Basic/Diagnostic.h"
17e5dd7070Spatrick #include "clang/Basic/FileManager.h"
18e5dd7070Spatrick #include "clang/Basic/LLVM.h"
19e5dd7070Spatrick #include "clang/Basic/SourceLocation.h"
20e5dd7070Spatrick #include "clang/Basic/SourceManager.h"
21e5dd7070Spatrick #include "clang/Edit/Commit.h"
22e5dd7070Spatrick #include "clang/Edit/EditsReceiver.h"
23e5dd7070Spatrick #include "clang/Frontend/FrontendDiagnostic.h"
24e5dd7070Spatrick #include "clang/Rewrite/Core/RewriteBuffer.h"
25e5dd7070Spatrick #include "clang/Rewrite/Core/Rewriter.h"
26e5dd7070Spatrick #include "llvm/ADT/StringRef.h"
27e5dd7070Spatrick #include "llvm/Support/FileSystem.h"
28e5dd7070Spatrick #include "llvm/Support/raw_ostream.h"
29e5dd7070Spatrick #include <cstdio>
30e5dd7070Spatrick #include <memory>
31e5dd7070Spatrick #include <string>
32e5dd7070Spatrick #include <system_error>
33e5dd7070Spatrick #include <utility>
34e5dd7070Spatrick
35e5dd7070Spatrick using namespace clang;
36e5dd7070Spatrick
FixItRewriter(DiagnosticsEngine & Diags,SourceManager & SourceMgr,const LangOptions & LangOpts,FixItOptions * FixItOpts)37e5dd7070Spatrick FixItRewriter::FixItRewriter(DiagnosticsEngine &Diags, SourceManager &SourceMgr,
38e5dd7070Spatrick const LangOptions &LangOpts,
39e5dd7070Spatrick FixItOptions *FixItOpts)
40e5dd7070Spatrick : Diags(Diags), Editor(SourceMgr, LangOpts), Rewrite(SourceMgr, LangOpts),
41e5dd7070Spatrick FixItOpts(FixItOpts) {
42e5dd7070Spatrick Owner = Diags.takeClient();
43e5dd7070Spatrick Client = Diags.getClient();
44e5dd7070Spatrick Diags.setClient(this, false);
45e5dd7070Spatrick }
46e5dd7070Spatrick
~FixItRewriter()47e5dd7070Spatrick FixItRewriter::~FixItRewriter() {
48e5dd7070Spatrick Diags.setClient(Client, Owner.release() != nullptr);
49e5dd7070Spatrick }
50e5dd7070Spatrick
WriteFixedFile(FileID ID,raw_ostream & OS)51e5dd7070Spatrick bool FixItRewriter::WriteFixedFile(FileID ID, raw_ostream &OS) {
52e5dd7070Spatrick const RewriteBuffer *RewriteBuf = Rewrite.getRewriteBufferFor(ID);
53e5dd7070Spatrick if (!RewriteBuf) return true;
54e5dd7070Spatrick RewriteBuf->write(OS);
55e5dd7070Spatrick OS.flush();
56e5dd7070Spatrick return false;
57e5dd7070Spatrick }
58e5dd7070Spatrick
59e5dd7070Spatrick namespace {
60e5dd7070Spatrick
61e5dd7070Spatrick class RewritesReceiver : public edit::EditsReceiver {
62e5dd7070Spatrick Rewriter &Rewrite;
63e5dd7070Spatrick
64e5dd7070Spatrick public:
RewritesReceiver(Rewriter & Rewrite)65e5dd7070Spatrick RewritesReceiver(Rewriter &Rewrite) : Rewrite(Rewrite) {}
66e5dd7070Spatrick
insert(SourceLocation loc,StringRef text)67e5dd7070Spatrick void insert(SourceLocation loc, StringRef text) override {
68e5dd7070Spatrick Rewrite.InsertText(loc, text);
69e5dd7070Spatrick }
70e5dd7070Spatrick
replace(CharSourceRange range,StringRef text)71e5dd7070Spatrick void replace(CharSourceRange range, StringRef text) override {
72e5dd7070Spatrick Rewrite.ReplaceText(range.getBegin(), Rewrite.getRangeSize(range), text);
73e5dd7070Spatrick }
74e5dd7070Spatrick };
75e5dd7070Spatrick
76e5dd7070Spatrick } // namespace
77e5dd7070Spatrick
WriteFixedFiles(std::vector<std::pair<std::string,std::string>> * RewrittenFiles)78e5dd7070Spatrick bool FixItRewriter::WriteFixedFiles(
79e5dd7070Spatrick std::vector<std::pair<std::string, std::string>> *RewrittenFiles) {
80e5dd7070Spatrick if (NumFailures > 0 && !FixItOpts->FixWhatYouCan) {
81e5dd7070Spatrick Diag(FullSourceLoc(), diag::warn_fixit_no_changes);
82e5dd7070Spatrick return true;
83e5dd7070Spatrick }
84e5dd7070Spatrick
85e5dd7070Spatrick RewritesReceiver Rec(Rewrite);
86e5dd7070Spatrick Editor.applyRewrites(Rec);
87e5dd7070Spatrick
88e5dd7070Spatrick if (FixItOpts->InPlace) {
89e5dd7070Spatrick // Overwriting open files on Windows is tricky, but the rewriter can do it
90e5dd7070Spatrick // for us.
91e5dd7070Spatrick Rewrite.overwriteChangedFiles();
92e5dd7070Spatrick return false;
93e5dd7070Spatrick }
94e5dd7070Spatrick
95e5dd7070Spatrick for (iterator I = buffer_begin(), E = buffer_end(); I != E; ++I) {
96e5dd7070Spatrick const FileEntry *Entry = Rewrite.getSourceMgr().getFileEntryForID(I->first);
97e5dd7070Spatrick int fd;
98*ec727ea7Spatrick std::string Filename =
99*ec727ea7Spatrick FixItOpts->RewriteFilename(std::string(Entry->getName()), fd);
100e5dd7070Spatrick std::error_code EC;
101e5dd7070Spatrick std::unique_ptr<llvm::raw_fd_ostream> OS;
102e5dd7070Spatrick if (fd != -1) {
103e5dd7070Spatrick OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
104e5dd7070Spatrick } else {
105e5dd7070Spatrick OS.reset(new llvm::raw_fd_ostream(Filename, EC, llvm::sys::fs::OF_None));
106e5dd7070Spatrick }
107e5dd7070Spatrick if (EC) {
108e5dd7070Spatrick Diags.Report(clang::diag::err_fe_unable_to_open_output) << Filename
109e5dd7070Spatrick << EC.message();
110e5dd7070Spatrick continue;
111e5dd7070Spatrick }
112e5dd7070Spatrick RewriteBuffer &RewriteBuf = I->second;
113e5dd7070Spatrick RewriteBuf.write(*OS);
114e5dd7070Spatrick OS->flush();
115e5dd7070Spatrick
116e5dd7070Spatrick if (RewrittenFiles)
117*ec727ea7Spatrick RewrittenFiles->push_back(
118*ec727ea7Spatrick std::make_pair(std::string(Entry->getName()), Filename));
119e5dd7070Spatrick }
120e5dd7070Spatrick
121e5dd7070Spatrick return false;
122e5dd7070Spatrick }
123e5dd7070Spatrick
IncludeInDiagnosticCounts() const124e5dd7070Spatrick bool FixItRewriter::IncludeInDiagnosticCounts() const {
125e5dd7070Spatrick return Client ? Client->IncludeInDiagnosticCounts() : true;
126e5dd7070Spatrick }
127e5dd7070Spatrick
HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,const Diagnostic & Info)128e5dd7070Spatrick void FixItRewriter::HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
129e5dd7070Spatrick const Diagnostic &Info) {
130e5dd7070Spatrick // Default implementation (Warnings/errors count).
131e5dd7070Spatrick DiagnosticConsumer::HandleDiagnostic(DiagLevel, Info);
132e5dd7070Spatrick
133e5dd7070Spatrick if (!FixItOpts->Silent ||
134e5dd7070Spatrick DiagLevel >= DiagnosticsEngine::Error ||
135e5dd7070Spatrick (DiagLevel == DiagnosticsEngine::Note && !PrevDiagSilenced) ||
136e5dd7070Spatrick (DiagLevel > DiagnosticsEngine::Note && Info.getNumFixItHints())) {
137e5dd7070Spatrick Client->HandleDiagnostic(DiagLevel, Info);
138e5dd7070Spatrick PrevDiagSilenced = false;
139e5dd7070Spatrick } else {
140e5dd7070Spatrick PrevDiagSilenced = true;
141e5dd7070Spatrick }
142e5dd7070Spatrick
143e5dd7070Spatrick // Skip over any diagnostics that are ignored or notes.
144e5dd7070Spatrick if (DiagLevel <= DiagnosticsEngine::Note)
145e5dd7070Spatrick return;
146e5dd7070Spatrick // Skip over errors if we are only fixing warnings.
147e5dd7070Spatrick if (DiagLevel >= DiagnosticsEngine::Error && FixItOpts->FixOnlyWarnings) {
148e5dd7070Spatrick ++NumFailures;
149e5dd7070Spatrick return;
150e5dd7070Spatrick }
151e5dd7070Spatrick
152e5dd7070Spatrick // Make sure that we can perform all of the modifications we
153e5dd7070Spatrick // in this diagnostic.
154e5dd7070Spatrick edit::Commit commit(Editor);
155e5dd7070Spatrick for (unsigned Idx = 0, Last = Info.getNumFixItHints();
156e5dd7070Spatrick Idx < Last; ++Idx) {
157e5dd7070Spatrick const FixItHint &Hint = Info.getFixItHint(Idx);
158e5dd7070Spatrick
159e5dd7070Spatrick if (Hint.CodeToInsert.empty()) {
160e5dd7070Spatrick if (Hint.InsertFromRange.isValid())
161e5dd7070Spatrick commit.insertFromRange(Hint.RemoveRange.getBegin(),
162e5dd7070Spatrick Hint.InsertFromRange, /*afterToken=*/false,
163e5dd7070Spatrick Hint.BeforePreviousInsertions);
164e5dd7070Spatrick else
165e5dd7070Spatrick commit.remove(Hint.RemoveRange);
166e5dd7070Spatrick } else {
167e5dd7070Spatrick if (Hint.RemoveRange.isTokenRange() ||
168e5dd7070Spatrick Hint.RemoveRange.getBegin() != Hint.RemoveRange.getEnd())
169e5dd7070Spatrick commit.replace(Hint.RemoveRange, Hint.CodeToInsert);
170e5dd7070Spatrick else
171e5dd7070Spatrick commit.insert(Hint.RemoveRange.getBegin(), Hint.CodeToInsert,
172e5dd7070Spatrick /*afterToken=*/false, Hint.BeforePreviousInsertions);
173e5dd7070Spatrick }
174e5dd7070Spatrick }
175e5dd7070Spatrick bool CanRewrite = Info.getNumFixItHints() > 0 && commit.isCommitable();
176e5dd7070Spatrick
177e5dd7070Spatrick if (!CanRewrite) {
178e5dd7070Spatrick if (Info.getNumFixItHints() > 0)
179e5dd7070Spatrick Diag(Info.getLocation(), diag::note_fixit_in_macro);
180e5dd7070Spatrick
181e5dd7070Spatrick // If this was an error, refuse to perform any rewriting.
182e5dd7070Spatrick if (DiagLevel >= DiagnosticsEngine::Error) {
183e5dd7070Spatrick if (++NumFailures == 1)
184e5dd7070Spatrick Diag(Info.getLocation(), diag::note_fixit_unfixed_error);
185e5dd7070Spatrick }
186e5dd7070Spatrick return;
187e5dd7070Spatrick }
188e5dd7070Spatrick
189e5dd7070Spatrick if (!Editor.commit(commit)) {
190e5dd7070Spatrick ++NumFailures;
191e5dd7070Spatrick Diag(Info.getLocation(), diag::note_fixit_failed);
192e5dd7070Spatrick return;
193e5dd7070Spatrick }
194e5dd7070Spatrick
195e5dd7070Spatrick Diag(Info.getLocation(), diag::note_fixit_applied);
196e5dd7070Spatrick }
197e5dd7070Spatrick
198e5dd7070Spatrick /// Emit a diagnostic via the adapted diagnostic client.
Diag(SourceLocation Loc,unsigned DiagID)199e5dd7070Spatrick void FixItRewriter::Diag(SourceLocation Loc, unsigned DiagID) {
200e5dd7070Spatrick // When producing this diagnostic, we temporarily bypass ourselves,
201e5dd7070Spatrick // clear out any current diagnostic, and let the downstream client
202e5dd7070Spatrick // format the diagnostic.
203e5dd7070Spatrick Diags.setClient(Client, false);
204e5dd7070Spatrick Diags.Clear();
205e5dd7070Spatrick Diags.Report(Loc, DiagID);
206e5dd7070Spatrick Diags.setClient(this, false);
207e5dd7070Spatrick }
208e5dd7070Spatrick
209e5dd7070Spatrick FixItOptions::~FixItOptions() = default;
210