forked from OSchip/llvm-project
121 lines
4.2 KiB
C++
121 lines
4.2 KiB
C++
//===---------- TransformerClangTidyCheck.cpp - clang-tidy ----------------===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "TransformerClangTidyCheck.h"
|
|
#include "clang/Lex/Preprocessor.h"
|
|
#include "llvm/ADT/STLExtras.h"
|
|
|
|
namespace clang {
|
|
namespace tidy {
|
|
namespace utils {
|
|
using transformer::RewriteRule;
|
|
|
|
#ifndef NDEBUG
|
|
static bool hasExplanation(const RewriteRule::Case &C) {
|
|
return C.Explanation != nullptr;
|
|
}
|
|
#endif
|
|
|
|
static void verifyRule(const RewriteRule &Rule) {
|
|
assert(llvm::all_of(Rule.Cases, hasExplanation) &&
|
|
"clang-tidy checks must have an explanation by default;"
|
|
" explicitly provide an empty explanation if none is desired");
|
|
}
|
|
|
|
TransformerClangTidyCheck::TransformerClangTidyCheck(StringRef Name,
|
|
ClangTidyContext *Context)
|
|
: ClangTidyCheck(Name, Context),
|
|
Inserter(
|
|
Options.getLocalOrGlobal("IncludeStyle", IncludeSorter::IS_LLVM)) {}
|
|
|
|
// This constructor cannot dispatch to the simpler one (below), because, in
|
|
// order to get meaningful results from `getLangOpts` and `Options`, we need the
|
|
// `ClangTidyCheck()` constructor to have been called. If we were to dispatch,
|
|
// we would be accessing `getLangOpts` and `Options` before the underlying
|
|
// `ClangTidyCheck` instance was properly initialized.
|
|
TransformerClangTidyCheck::TransformerClangTidyCheck(
|
|
std::function<Optional<RewriteRule>(const LangOptions &,
|
|
const OptionsView &)>
|
|
MakeRule,
|
|
StringRef Name, ClangTidyContext *Context)
|
|
: TransformerClangTidyCheck(Name, Context) {
|
|
if (Optional<RewriteRule> R = MakeRule(getLangOpts(), Options))
|
|
setRule(std::move(*R));
|
|
}
|
|
|
|
TransformerClangTidyCheck::TransformerClangTidyCheck(RewriteRule R,
|
|
StringRef Name,
|
|
ClangTidyContext *Context)
|
|
: TransformerClangTidyCheck(Name, Context) {
|
|
setRule(std::move(R));
|
|
}
|
|
|
|
void TransformerClangTidyCheck::setRule(transformer::RewriteRule R) {
|
|
verifyRule(R);
|
|
Rule = std::move(R);
|
|
}
|
|
|
|
void TransformerClangTidyCheck::registerPPCallbacks(
|
|
const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) {
|
|
Inserter.registerPreprocessor(PP);
|
|
}
|
|
|
|
void TransformerClangTidyCheck::registerMatchers(
|
|
ast_matchers::MatchFinder *Finder) {
|
|
if (!Rule.Cases.empty())
|
|
for (auto &Matcher : transformer::detail::buildMatchers(Rule))
|
|
Finder->addDynamicMatcher(Matcher, this);
|
|
}
|
|
|
|
void TransformerClangTidyCheck::check(
|
|
const ast_matchers::MatchFinder::MatchResult &Result) {
|
|
if (Result.Context->getDiagnostics().hasErrorOccurred())
|
|
return;
|
|
|
|
RewriteRule::Case Case = transformer::detail::findSelectedCase(Result, Rule);
|
|
Expected<SmallVector<transformer::Edit, 1>> Edits = Case.Edits(Result);
|
|
if (!Edits) {
|
|
llvm::errs() << "Rewrite failed: " << llvm::toString(Edits.takeError())
|
|
<< "\n";
|
|
return;
|
|
}
|
|
|
|
// No rewrite applied, but no error encountered either.
|
|
if (Edits->empty())
|
|
return;
|
|
|
|
Expected<std::string> Explanation = Case.Explanation->eval(Result);
|
|
if (!Explanation) {
|
|
llvm::errs() << "Error in explanation: "
|
|
<< llvm::toString(Explanation.takeError()) << "\n";
|
|
return;
|
|
}
|
|
|
|
// Associate the diagnostic with the location of the first change.
|
|
DiagnosticBuilder Diag = diag((*Edits)[0].Range.getBegin(), *Explanation);
|
|
for (const auto &T : *Edits)
|
|
switch (T.Kind) {
|
|
case transformer::EditKind::Range:
|
|
Diag << FixItHint::CreateReplacement(T.Range, T.Replacement);
|
|
break;
|
|
case transformer::EditKind::AddInclude:
|
|
Diag << Inserter.createIncludeInsertion(
|
|
Result.SourceManager->getFileID(T.Range.getBegin()), T.Replacement);
|
|
break;
|
|
}
|
|
}
|
|
|
|
void TransformerClangTidyCheck::storeOptions(
|
|
ClangTidyOptions::OptionMap &Opts) {
|
|
Options.store(Opts, "IncludeStyle", Inserter.getStyle());
|
|
}
|
|
|
|
} // namespace utils
|
|
} // namespace tidy
|
|
} // namespace clang
|