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