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