Coverage Report

Created: 2020-09-22 08:39

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