mirror of
https://github.com/Gericom/teak-llvm.git
synced 2025-06-21 12:35:47 -04:00
f2879d8a48
Summary:
Motivation/Context: in the code review system integrating with clang-tidy,
clang-tidy doesn't provide a human-readable description of the fix. Usually
developers have to preview a code diff (before vs after apply the fix) to
understand what the fix does before applying a fix.
This patch proposes that each clang-tidy check provides a short and
actional fix description that can be shown in the UI, so that users can know
what the fix does without previewing diff.
This patch extends clang-tidy framework to support fix descriptions (will add implementations for
existing checks in the future). Fix descriptions and fixes are emitted via diagnostic::Note (rather than
attaching the main warning diagnostic).
Before this patch:
```
void MyCheck::check(...) {
...
diag(loc, "my check warning") << FixtItHint::CreateReplacement(...);
}
```
After:
```
void MyCheck::check(...) {
...
diag(loc, "my check warning"); // Emit a check warning
diag(loc, "fix description", DiagnosticIDs::Note) << FixtItHint::CreateReplacement(...); // Emit a diagnostic note and a fix
}
```
Reviewers: sammccall, alexfh
Reviewed By: alexfh
Subscribers: MyDeveloperDay, Eugene.Zelenko, aaron.ballman, JonasToth, xazax.hun, jdoerfert, cfe-commits
Tags: #clang-tools-extra, #clang
Differential Revision: https://reviews.llvm.org/D59932
llvm-svn: 358576
62 lines
2.3 KiB
C++
62 lines
2.3 KiB
C++
//===--- Diagnostic.cpp - Framework for clang diagnostics tools ----------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// Implements classes to support/store diagnostics refactoring.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "clang/Tooling/Core/Diagnostic.h"
|
|
#include "clang/Basic/SourceManager.h"
|
|
#include "llvm/ADT/STLExtras.h"
|
|
|
|
namespace clang {
|
|
namespace tooling {
|
|
|
|
DiagnosticMessage::DiagnosticMessage(llvm::StringRef Message)
|
|
: Message(Message), FileOffset(0) {}
|
|
|
|
DiagnosticMessage::DiagnosticMessage(llvm::StringRef Message,
|
|
const SourceManager &Sources,
|
|
SourceLocation Loc)
|
|
: Message(Message), FileOffset(0) {
|
|
assert(Loc.isValid() && Loc.isFileID());
|
|
FilePath = Sources.getFilename(Loc);
|
|
|
|
// Don't store offset in the scratch space. It doesn't tell anything to the
|
|
// user. Moreover, it depends on the history of macro expansions and thus
|
|
// prevents deduplication of warnings in headers.
|
|
if (!FilePath.empty())
|
|
FileOffset = Sources.getFileOffset(Loc);
|
|
}
|
|
|
|
Diagnostic::Diagnostic(llvm::StringRef DiagnosticName,
|
|
Diagnostic::Level DiagLevel, StringRef BuildDirectory)
|
|
: DiagnosticName(DiagnosticName), DiagLevel(DiagLevel),
|
|
BuildDirectory(BuildDirectory) {}
|
|
|
|
Diagnostic::Diagnostic(llvm::StringRef DiagnosticName,
|
|
const DiagnosticMessage &Message,
|
|
const SmallVector<DiagnosticMessage, 1> &Notes,
|
|
Level DiagLevel, llvm::StringRef BuildDirectory)
|
|
: DiagnosticName(DiagnosticName), Message(Message), Notes(Notes),
|
|
DiagLevel(DiagLevel), BuildDirectory(BuildDirectory) {}
|
|
|
|
const llvm::StringMap<Replacements> *selectFirstFix(const Diagnostic& D) {
|
|
if (!D.Message.Fix.empty())
|
|
return &D.Message.Fix;
|
|
auto Iter = llvm::find_if(D.Notes, [](const tooling::DiagnosticMessage &D) {
|
|
return !D.Fix.empty();
|
|
});
|
|
if (Iter != D.Notes.end())
|
|
return &Iter->Fix;
|
|
return nullptr;
|
|
}
|
|
|
|
} // end namespace tooling
|
|
} // end namespace clang
|