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