mirror of
https://github.com/Gericom/teak-llvm.git
synced 2025-06-25 06:18:56 -04:00
039af0ea03
Summary: Tidy check behavior often depends on language and/or clang-tidy options. This revision allows a user of TranformerClangTidyCheck to pass rule _generator_ in place of a rule, where the generator takes both the language and clang-tidy options. Additionally, the generator returns an `Optional` to allow for the case where the check is deemed irrelevant/disable based on those options. Reviewers: gribozavr Subscribers: xazax.hun, cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D63288 llvm-svn: 364442
67 lines
2.6 KiB
C++
67 lines
2.6 KiB
C++
//===---------- TransformerClangTidyCheck.h - 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_TRANSFORMER_CLANG_TIDY_CHECK_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_TRANSFORMER_CLANG_TIDY_CHECK_H
|
|
|
|
#include "../ClangTidy.h"
|
|
#include "clang/ASTMatchers/ASTMatchFinder.h"
|
|
#include "clang/Tooling/Refactoring/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 {
|
|
public:
|
|
// \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).
|
|
TransformerClangTidyCheck(std::function<Optional<tooling::RewriteRule>(
|
|
const LangOptions &, const OptionsView &)>
|
|
MakeRule,
|
|
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 registerMatchers(ast_matchers::MatchFinder *Finder) final;
|
|
void check(const ast_matchers::MatchFinder::MatchResult &Result) final;
|
|
|
|
private:
|
|
Optional<tooling::RewriteRule> Rule;
|
|
};
|
|
|
|
} // namespace utils
|
|
} // namespace tidy
|
|
} // namespace clang
|
|
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_TRANSFORMER_CLANG_TIDY_CHECK_H
|