clang-tools  10.0.0svn
ClangTidyModule.h
Go to the documentation of this file.
1 //===--- ClangTidyModule.h - clang-tidy -------------------------*- C++ -*-===//
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 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CLANGTIDYMODULE_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CLANGTIDYMODULE_H
11 
12 #include "ClangTidy.h"
13 #include "llvm/ADT/StringRef.h"
14 #include <functional>
15 #include <map>
16 #include <memory>
17 #include <string>
18 #include <utility>
19 
20 namespace clang {
21 namespace tidy {
22 
23 /// A collection of \c ClangTidyCheckFactory instances.
24 ///
25 /// All clang-tidy modules register their check factories with an instance of
26 /// this object.
28 public:
29  using CheckFactory = std::function<std::unique_ptr<ClangTidyCheck>(
30  StringRef Name, ClangTidyContext *Context)>;
31 
32  /// Registers check \p Factory with name \p Name.
33  ///
34  /// For all checks that have default constructors, use \c registerCheck.
35  void registerCheckFactory(StringRef Name, CheckFactory Factory);
36 
37  /// Registers the \c CheckType with the name \p Name.
38  ///
39  /// This method should be used for all \c ClangTidyChecks that don't require
40  /// constructor parameters.
41  ///
42  /// For example, if have a clang-tidy check like:
43  /// \code
44  /// class MyTidyCheck : public ClangTidyCheck {
45  /// void registerMatchers(ast_matchers::MatchFinder *Finder) override {
46  /// ..
47  /// }
48  /// };
49  /// \endcode
50  /// you can register it with:
51  /// \code
52  /// class MyModule : public ClangTidyModule {
53  /// void addCheckFactories(ClangTidyCheckFactories &Factories) override {
54  /// Factories.registerCheck<MyTidyCheck>("myproject-my-check");
55  /// }
56  /// };
57  /// \endcode
58  template <typename CheckType> void registerCheck(StringRef CheckName) {
59  registerCheckFactory(CheckName,
60  [](StringRef Name, ClangTidyContext *Context) {
61  return std::make_unique<CheckType>(Name, Context);
62  });
63  }
64 
65  /// Create instances of checks that are enabled.
66  std::vector<std::unique_ptr<ClangTidyCheck>>
68 
69  typedef std::map<std::string, CheckFactory> FactoryMap;
70  FactoryMap::const_iterator begin() const { return Factories.begin(); }
71  FactoryMap::const_iterator end() const { return Factories.end(); }
72  bool empty() const { return Factories.empty(); }
73 
74 private:
75  FactoryMap Factories;
76 };
77 
78 /// A clang-tidy module groups a number of \c ClangTidyChecks and gives
79 /// them a prefixed name.
81 public:
82  virtual ~ClangTidyModule() {}
83 
84  /// Implement this function in order to register all \c CheckFactories
85  /// belonging to this module.
86  virtual void addCheckFactories(ClangTidyCheckFactories &CheckFactories) = 0;
87 
88  /// Gets default options for checks defined in this module.
89  virtual ClangTidyOptions getModuleOptions();
90 };
91 
92 } // end namespace tidy
93 } // end namespace clang
94 
95 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CLANGTIDYMODULE_H
void registerCheckFactory(StringRef Name, CheckFactory Factory)
Registers check Factory with name Name.
void registerCheck(StringRef CheckName)
Registers the CheckType with the name Name.
Contains options for clang-tidy.
A collection of ClangTidyCheckFactory instances.
FactoryMap::const_iterator begin() const
std::map< std::string, CheckFactory > FactoryMap
A clang-tidy module groups a number of ClangTidyChecks and gives them a prefixed name.
std::function< std::unique_ptr< ClangTidyCheck >(StringRef Name, ClangTidyContext *Context)> CheckFactory
static constexpr llvm::StringLiteral Name
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
FactoryMap::const_iterator end() const
std::vector< std::unique_ptr< ClangTidyCheck > > createChecks(ClangTidyContext *Context)
Create instances of checks that are enabled.