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