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