xref: /llvm-project/clang-tools-extra/clang-tidy/cppcoreguidelines/CppCoreGuidelinesTidyModule.cpp (revision b3700c34aa712fb4034fb2c31b0767993b1a6b7f)
1 //===-- CppCoreGuidelinesTidyModule.cpp - clang-tidy ----------------------===//
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 #include "../ClangTidy.h"
10 #include "../ClangTidyModule.h"
11 #include "../ClangTidyModuleRegistry.h"
12 #include "../misc/NonPrivateMemberVariablesInClassesCheck.h"
13 #include "../misc/UnconventionalAssignOperatorCheck.h"
14 #include "../modernize/AvoidCArraysCheck.h"
15 #include "../modernize/MacroToEnumCheck.h"
16 #include "../modernize/UseDefaultMemberInitCheck.h"
17 #include "../modernize/UseOverrideCheck.h"
18 #include "../performance/NoexceptDestructorCheck.h"
19 #include "../performance/NoexceptMoveConstructorCheck.h"
20 #include "../performance/NoexceptSwapCheck.h"
21 #include "../readability/MagicNumbersCheck.h"
22 #include "AvoidCapturingLambdaCoroutinesCheck.h"
23 #include "AvoidConstOrRefDataMembersCheck.h"
24 #include "AvoidDoWhileCheck.h"
25 #include "AvoidGotoCheck.h"
26 #include "AvoidNonConstGlobalVariablesCheck.h"
27 #include "AvoidReferenceCoroutineParametersCheck.h"
28 #include "InitVariablesCheck.h"
29 #include "InterfacesGlobalInitCheck.h"
30 #include "MacroUsageCheck.h"
31 #include "MisleadingCaptureDefaultByValueCheck.h"
32 #include "MissingStdForwardCheck.h"
33 #include "NarrowingConversionsCheck.h"
34 #include "NoMallocCheck.h"
35 #include "OwningMemoryCheck.h"
36 #include "PreferMemberInitializerCheck.h"
37 #include "ProBoundsArrayToPointerDecayCheck.h"
38 #include "ProBoundsConstantArrayIndexCheck.h"
39 #include "ProBoundsPointerArithmeticCheck.h"
40 #include "ProTypeConstCastCheck.h"
41 #include "ProTypeCstyleCastCheck.h"
42 #include "ProTypeMemberInitCheck.h"
43 #include "ProTypeReinterpretCastCheck.h"
44 #include "ProTypeStaticCastDowncastCheck.h"
45 #include "ProTypeUnionAccessCheck.h"
46 #include "ProTypeVarargCheck.h"
47 #include "RvalueReferenceParamNotMovedCheck.h"
48 #include "SlicingCheck.h"
49 #include "SpecialMemberFunctionsCheck.h"
50 #include "VirtualClassDestructorCheck.h"
51 
52 namespace clang::tidy {
53 namespace cppcoreguidelines {
54 
55 /// A module containing checks of the C++ Core Guidelines
56 class CppCoreGuidelinesModule : public ClangTidyModule {
57 public:
58   void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override {
59     CheckFactories.registerCheck<AvoidCapturingLambdaCoroutinesCheck>(
60         "cppcoreguidelines-avoid-capturing-lambda-coroutines");
61     CheckFactories.registerCheck<modernize::AvoidCArraysCheck>(
62         "cppcoreguidelines-avoid-c-arrays");
63     CheckFactories.registerCheck<AvoidConstOrRefDataMembersCheck>(
64         "cppcoreguidelines-avoid-const-or-ref-data-members");
65     CheckFactories.registerCheck<AvoidDoWhileCheck>(
66         "cppcoreguidelines-avoid-do-while");
67     CheckFactories.registerCheck<AvoidGotoCheck>(
68         "cppcoreguidelines-avoid-goto");
69     CheckFactories.registerCheck<readability::MagicNumbersCheck>(
70         "cppcoreguidelines-avoid-magic-numbers");
71     CheckFactories.registerCheck<AvoidNonConstGlobalVariablesCheck>(
72         "cppcoreguidelines-avoid-non-const-global-variables");
73     CheckFactories.registerCheck<AvoidReferenceCoroutineParametersCheck>(
74         "cppcoreguidelines-avoid-reference-coroutine-parameters");
75     CheckFactories.registerCheck<modernize::UseOverrideCheck>(
76         "cppcoreguidelines-explicit-virtual-functions");
77     CheckFactories.registerCheck<InitVariablesCheck>(
78         "cppcoreguidelines-init-variables");
79     CheckFactories.registerCheck<InterfacesGlobalInitCheck>(
80         "cppcoreguidelines-interfaces-global-init");
81     CheckFactories.registerCheck<modernize::MacroToEnumCheck>(
82         "cppcoreguidelines-macro-to-enum");
83     CheckFactories.registerCheck<MacroUsageCheck>(
84         "cppcoreguidelines-macro-usage");
85     CheckFactories.registerCheck<MisleadingCaptureDefaultByValueCheck>(
86         "cppcoreguidelines-misleading-capture-default-by-value");
87     CheckFactories.registerCheck<MissingStdForwardCheck>(
88         "cppcoreguidelines-missing-std-forward");
89     CheckFactories.registerCheck<NarrowingConversionsCheck>(
90         "cppcoreguidelines-narrowing-conversions");
91     CheckFactories.registerCheck<NoMallocCheck>("cppcoreguidelines-no-malloc");
92     CheckFactories.registerCheck<performance::NoexceptDestructorCheck>(
93         "cppcoreguidelines-noexcept-destructor");
94     CheckFactories.registerCheck<performance::NoexceptMoveConstructorCheck>(
95         "cppcoreguidelines-noexcept-move-operations");
96     CheckFactories.registerCheck<performance::NoexceptSwapCheck>(
97         "cppcoreguidelines-noexcept-swap");
98     CheckFactories.registerCheck<misc::NonPrivateMemberVariablesInClassesCheck>(
99         "cppcoreguidelines-non-private-member-variables-in-classes");
100     CheckFactories.registerCheck<OwningMemoryCheck>(
101         "cppcoreguidelines-owning-memory");
102     CheckFactories.registerCheck<PreferMemberInitializerCheck>(
103         "cppcoreguidelines-prefer-member-initializer");
104     CheckFactories.registerCheck<ProBoundsArrayToPointerDecayCheck>(
105         "cppcoreguidelines-pro-bounds-array-to-pointer-decay");
106     CheckFactories.registerCheck<ProBoundsConstantArrayIndexCheck>(
107         "cppcoreguidelines-pro-bounds-constant-array-index");
108     CheckFactories.registerCheck<ProBoundsPointerArithmeticCheck>(
109         "cppcoreguidelines-pro-bounds-pointer-arithmetic");
110     CheckFactories.registerCheck<ProTypeConstCastCheck>(
111         "cppcoreguidelines-pro-type-const-cast");
112     CheckFactories.registerCheck<ProTypeCstyleCastCheck>(
113         "cppcoreguidelines-pro-type-cstyle-cast");
114     CheckFactories.registerCheck<ProTypeMemberInitCheck>(
115         "cppcoreguidelines-pro-type-member-init");
116     CheckFactories.registerCheck<ProTypeReinterpretCastCheck>(
117         "cppcoreguidelines-pro-type-reinterpret-cast");
118     CheckFactories.registerCheck<ProTypeStaticCastDowncastCheck>(
119         "cppcoreguidelines-pro-type-static-cast-downcast");
120     CheckFactories.registerCheck<ProTypeUnionAccessCheck>(
121         "cppcoreguidelines-pro-type-union-access");
122     CheckFactories.registerCheck<ProTypeVarargCheck>(
123         "cppcoreguidelines-pro-type-vararg");
124     CheckFactories.registerCheck<RvalueReferenceParamNotMovedCheck>(
125         "cppcoreguidelines-rvalue-reference-param-not-moved");
126     CheckFactories.registerCheck<SpecialMemberFunctionsCheck>(
127         "cppcoreguidelines-special-member-functions");
128     CheckFactories.registerCheck<SlicingCheck>("cppcoreguidelines-slicing");
129     CheckFactories.registerCheck<modernize::UseDefaultMemberInitCheck>(
130         "cppcoreguidelines-use-default-member-init");
131     CheckFactories.registerCheck<misc::UnconventionalAssignOperatorCheck>(
132         "cppcoreguidelines-c-copy-assignment-signature");
133     CheckFactories.registerCheck<VirtualClassDestructorCheck>(
134         "cppcoreguidelines-virtual-class-destructor");
135   }
136 
137   ClangTidyOptions getModuleOptions() override {
138     ClangTidyOptions Options;
139     ClangTidyOptions::OptionMap &Opts = Options.CheckOptions;
140 
141     Opts["cppcoreguidelines-non-private-member-variables-in-classes."
142          "IgnoreClassesWithAllMemberVariablesBeingPublic"] = "true";
143 
144     return Options;
145   }
146 };
147 
148 // Register the LLVMTidyModule using this statically initialized variable.
149 static ClangTidyModuleRegistry::Add<CppCoreGuidelinesModule>
150     X("cppcoreguidelines-module", "Adds checks for the C++ Core Guidelines.");
151 
152 } // namespace cppcoreguidelines
153 
154 // This anchor is used to force the linker to link in the generated object file
155 // and thus register the CppCoreGuidelinesModule.
156 volatile int CppCoreGuidelinesModuleAnchorSource = 0;
157 
158 } // namespace clang::tidy
159