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