blob: bcbc41507db2265138fb7e775f7c1034c2d44eec [file] [log] [blame]
//===---------- TransformerClangTidyCheck.h - clang-tidy ------------------===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "../ClangTidy.h"
#include "../utils/IncludeInserter.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/Frontend/CompilerInstance.h"
#include "clang/Tooling/Transformer/Transformer.h"
#include <deque>
#include <vector>
namespace clang {
namespace tidy {
namespace utils {
// A base class for defining a ClangTidy check based on a `RewriteRule`.
// For example, given a rule `MyCheckAsRewriteRule`, one can define a tidy check
// as follows:
// class MyCheck : public TransformerClangTidyCheck {
// public:
// MyCheck(StringRef Name, ClangTidyContext *Context)
// : TransformerClangTidyCheck(MyCheckAsRewriteRule, Name, Context) {}
// };
class TransformerClangTidyCheck : public ClangTidyCheck {
// \p MakeRule generates the rewrite rule to be used by the check, based on
// the given language and clang-tidy options. It can return \c None to handle
// cases where the options disable the check.
// All cases in the rule generated by \p MakeRule must have a non-null \c
// Explanation, even though \c Explanation is optional for RewriteRule in
// general. Because the primary purpose of clang-tidy checks is to provide
// users with diagnostics, we assume that a missing explanation is a bug. If
// no explanation is desired, indicate that explicitly (for example, by
// passing `text("no explanation")` to `makeRule` as the `Explanation`
// argument).
const LangOptions &, const OptionsView &)>
StringRef Name, ClangTidyContext *Context);
// Convenience overload of the constructor when the rule doesn't depend on any
// of the language or clang-tidy options.
TransformerClangTidyCheck(tooling::RewriteRule R, StringRef Name,
ClangTidyContext *Context);
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
Preprocessor *ModuleExpanderPP) override;
void registerMatchers(ast_matchers::MatchFinder *Finder) final;
void check(const ast_matchers::MatchFinder::MatchResult &Result) final;
Optional<tooling::RewriteRule> Rule;
std::unique_ptr<clang::tidy::utils::IncludeInserter> Inserter;
} // namespace utils
} // namespace tidy
} // namespace clang