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