clang-tools 19.0.0git
CppCoreGuidelinesTidyModule.cpp
Go to the documentation of this file.
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/MacroToEnumCheck.h"
16#include "../modernize/UseDefaultMemberInitCheck.h"
17#include "../modernize/UseOverrideCheck.h"
18#include "../performance/NoexceptDestructorCheck.h"
19#include "../performance/NoexceptMoveConstructorCheck.h"
20#include "../performance/NoexceptSwapCheck.h"
21#include "../readability/MagicNumbersCheck.h"
22#include "AvoidCapturingLambdaCoroutinesCheck.h"
23#include "AvoidConstOrRefDataMembersCheck.h"
24#include "AvoidDoWhileCheck.h"
25#include "AvoidGotoCheck.h"
26#include "AvoidNonConstGlobalVariablesCheck.h"
27#include "AvoidReferenceCoroutineParametersCheck.h"
28#include "InitVariablesCheck.h"
29#include "InterfacesGlobalInitCheck.h"
30#include "MacroUsageCheck.h"
31#include "MisleadingCaptureDefaultByValueCheck.h"
32#include "MissingStdForwardCheck.h"
33#include "NarrowingConversionsCheck.h"
34#include "NoMallocCheck.h"
35#include "NoSuspendWithLockCheck.h"
36#include "OwningMemoryCheck.h"
37#include "PreferMemberInitializerCheck.h"
38#include "ProBoundsArrayToPointerDecayCheck.h"
39#include "ProBoundsConstantArrayIndexCheck.h"
40#include "ProBoundsPointerArithmeticCheck.h"
41#include "ProTypeConstCastCheck.h"
42#include "ProTypeCstyleCastCheck.h"
43#include "ProTypeMemberInitCheck.h"
44#include "ProTypeReinterpretCastCheck.h"
45#include "ProTypeStaticCastDowncastCheck.h"
46#include "ProTypeUnionAccessCheck.h"
47#include "ProTypeVarargCheck.h"
48#include "RvalueReferenceParamNotMovedCheck.h"
49#include "SlicingCheck.h"
50#include "SpecialMemberFunctionsCheck.h"
51#include "VirtualClassDestructorCheck.h"
52
53namespace clang::tidy {
54namespace cppcoreguidelines {
55
56/// A module containing checks of the C++ Core Guidelines
57class CppCoreGuidelinesModule : public ClangTidyModule {
58public:
59 void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override {
60 CheckFactories.registerCheck<AvoidCapturingLambdaCoroutinesCheck>(
61 "cppcoreguidelines-avoid-capturing-lambda-coroutines");
62 CheckFactories.registerCheck<modernize::AvoidCArraysCheck>(
63 "cppcoreguidelines-avoid-c-arrays");
64 CheckFactories.registerCheck<AvoidConstOrRefDataMembersCheck>(
65 "cppcoreguidelines-avoid-const-or-ref-data-members");
66 CheckFactories.registerCheck<AvoidDoWhileCheck>(
67 "cppcoreguidelines-avoid-do-while");
68 CheckFactories.registerCheck<AvoidGotoCheck>(
69 "cppcoreguidelines-avoid-goto");
70 CheckFactories.registerCheck<readability::MagicNumbersCheck>(
71 "cppcoreguidelines-avoid-magic-numbers");
72 CheckFactories.registerCheck<AvoidNonConstGlobalVariablesCheck>(
73 "cppcoreguidelines-avoid-non-const-global-variables");
74 CheckFactories.registerCheck<AvoidReferenceCoroutineParametersCheck>(
75 "cppcoreguidelines-avoid-reference-coroutine-parameters");
76 CheckFactories.registerCheck<modernize::UseOverrideCheck>(
77 "cppcoreguidelines-explicit-virtual-functions");
78 CheckFactories.registerCheck<InitVariablesCheck>(
79 "cppcoreguidelines-init-variables");
80 CheckFactories.registerCheck<InterfacesGlobalInitCheck>(
81 "cppcoreguidelines-interfaces-global-init");
82 CheckFactories.registerCheck<modernize::MacroToEnumCheck>(
83 "cppcoreguidelines-macro-to-enum");
84 CheckFactories.registerCheck<MacroUsageCheck>(
85 "cppcoreguidelines-macro-usage");
86 CheckFactories.registerCheck<MisleadingCaptureDefaultByValueCheck>(
87 "cppcoreguidelines-misleading-capture-default-by-value");
88 CheckFactories.registerCheck<MissingStdForwardCheck>(
89 "cppcoreguidelines-missing-std-forward");
90 CheckFactories.registerCheck<NarrowingConversionsCheck>(
91 "cppcoreguidelines-narrowing-conversions");
92 CheckFactories.registerCheck<NoMallocCheck>("cppcoreguidelines-no-malloc");
93 CheckFactories.registerCheck<NoSuspendWithLockCheck>(
94 "cppcoreguidelines-no-suspend-with-lock");
95 CheckFactories.registerCheck<performance::NoexceptDestructorCheck>(
96 "cppcoreguidelines-noexcept-destructor");
97 CheckFactories.registerCheck<performance::NoexceptMoveConstructorCheck>(
98 "cppcoreguidelines-noexcept-move-operations");
99 CheckFactories.registerCheck<performance::NoexceptSwapCheck>(
100 "cppcoreguidelines-noexcept-swap");
101 CheckFactories.registerCheck<misc::NonPrivateMemberVariablesInClassesCheck>(
102 "cppcoreguidelines-non-private-member-variables-in-classes");
103 CheckFactories.registerCheck<OwningMemoryCheck>(
104 "cppcoreguidelines-owning-memory");
105 CheckFactories.registerCheck<PreferMemberInitializerCheck>(
106 "cppcoreguidelines-prefer-member-initializer");
107 CheckFactories.registerCheck<ProBoundsArrayToPointerDecayCheck>(
108 "cppcoreguidelines-pro-bounds-array-to-pointer-decay");
109 CheckFactories.registerCheck<ProBoundsConstantArrayIndexCheck>(
110 "cppcoreguidelines-pro-bounds-constant-array-index");
111 CheckFactories.registerCheck<ProBoundsPointerArithmeticCheck>(
112 "cppcoreguidelines-pro-bounds-pointer-arithmetic");
113 CheckFactories.registerCheck<ProTypeConstCastCheck>(
114 "cppcoreguidelines-pro-type-const-cast");
115 CheckFactories.registerCheck<ProTypeCstyleCastCheck>(
116 "cppcoreguidelines-pro-type-cstyle-cast");
117 CheckFactories.registerCheck<ProTypeMemberInitCheck>(
118 "cppcoreguidelines-pro-type-member-init");
119 CheckFactories.registerCheck<ProTypeReinterpretCastCheck>(
120 "cppcoreguidelines-pro-type-reinterpret-cast");
121 CheckFactories.registerCheck<ProTypeStaticCastDowncastCheck>(
122 "cppcoreguidelines-pro-type-static-cast-downcast");
123 CheckFactories.registerCheck<ProTypeUnionAccessCheck>(
124 "cppcoreguidelines-pro-type-union-access");
125 CheckFactories.registerCheck<ProTypeVarargCheck>(
126 "cppcoreguidelines-pro-type-vararg");
127 CheckFactories.registerCheck<RvalueReferenceParamNotMovedCheck>(
128 "cppcoreguidelines-rvalue-reference-param-not-moved");
129 CheckFactories.registerCheck<SpecialMemberFunctionsCheck>(
130 "cppcoreguidelines-special-member-functions");
131 CheckFactories.registerCheck<SlicingCheck>("cppcoreguidelines-slicing");
132 CheckFactories.registerCheck<modernize::UseDefaultMemberInitCheck>(
133 "cppcoreguidelines-use-default-member-init");
134 CheckFactories.registerCheck<misc::UnconventionalAssignOperatorCheck>(
135 "cppcoreguidelines-c-copy-assignment-signature");
136 CheckFactories.registerCheck<VirtualClassDestructorCheck>(
137 "cppcoreguidelines-virtual-class-destructor");
138 }
139
140 ClangTidyOptions getModuleOptions() override {
141 ClangTidyOptions Options;
142 ClangTidyOptions::OptionMap &Opts = Options.CheckOptions;
143
144 Opts["cppcoreguidelines-non-private-member-variables-in-classes."
145 "IgnoreClassesWithAllMemberVariablesBeingPublic"] = "true";
146
147 return Options;
148 }
149};
150
151// Register the LLVMTidyModule using this statically initialized variable.
152static ClangTidyModuleRegistry::Add<CppCoreGuidelinesModule>
153 X("cppcoreguidelines-module", "Adds checks for the C++ Core Guidelines.");
154
155} // namespace cppcoreguidelines
156
157// This anchor is used to force the linker to link in the generated object file
158// and thus register the CppCoreGuidelinesModule.
159volatile int CppCoreGuidelinesModuleAnchorSource = 0;
160
161} // namespace clang::tidy
X
int X
Definition: LSPBinderTests.cpp:26
clang::tidy::ClangTidyCheckFactories
A collection of ClangTidyCheckFactory instances.
Definition: ClangTidyModule.h:27
clang::tidy::ClangTidyCheckFactories::registerCheck
void registerCheck(llvm::StringRef CheckName)
Registers the CheckType with the name Name.
Definition: ClangTidyModule.h:58
clang::tidy::ClangTidyModule
A clang-tidy module groups a number of ClangTidyChecks and gives them a prefixed name.
Definition: ClangTidyModule.h:84
clang::tidy::cppcoreguidelines::AvoidCapturingLambdaCoroutinesCheck
Flags C++20 coroutine lambdas with non-empty capture lists that may cause use-after-free errors and s...
Definition: AvoidCapturingLambdaCoroutinesCheck.h:22
clang::tidy::cppcoreguidelines::AvoidConstOrRefDataMembersCheck
Const-qualified or reference data members in classes should be avoided, as they make the class non-co...
Definition: AvoidConstOrRefDataMembersCheck.h:21
clang::tidy::cppcoreguidelines::AvoidDoWhileCheck
do-while loops are less readable than plan while loops, and can lead to subtle bugs.
Definition: AvoidDoWhileCheck.h:21
clang::tidy::cppcoreguidelines::AvoidGotoCheck
The usage of goto for control flow is error prone and should be replaced with looping constructs.
Definition: AvoidGotoCheck.h:21
clang::tidy::cppcoreguidelines::AvoidNonConstGlobalVariablesCheck
Non-const global variables hide dependencies and make the dependencies subject to unpredictable chang...
Definition: AvoidNonConstGlobalVariablesCheck.h:21
clang::tidy::cppcoreguidelines::CppCoreGuidelinesModule
A module containing checks of the C++ Core Guidelines.
Definition: CppCoreGuidelinesTidyModule.cpp:57
clang::tidy::cppcoreguidelines::CppCoreGuidelinesModule::getModuleOptions
ClangTidyOptions getModuleOptions() override
Gets default options for checks defined in this module.
Definition: CppCoreGuidelinesTidyModule.cpp:140
clang::tidy::cppcoreguidelines::CppCoreGuidelinesModule::addCheckFactories
void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override
Implement this function in order to register all CheckFactories belonging to this module.
Definition: CppCoreGuidelinesTidyModule.cpp:59
clang::tidy::cppcoreguidelines::InterfacesGlobalInitCheck
Flags possible initialization order issues of static variables.
Definition: InterfacesGlobalInitCheck.h:20
clang::tidy::cppcoreguidelines::MacroUsageCheck
Find macro usage that is considered problematic because better language constructs exist for the task...
Definition: MacroUsageCheck.h:25
clang::tidy::cppcoreguidelines::MisleadingCaptureDefaultByValueCheck
Warns when lambda specify a by-value capture default and capture this.
Definition: MisleadingCaptureDefaultByValueCheck.h:23
clang::tidy::cppcoreguidelines::MissingStdForwardCheck
Warns when a function accepting a forwarding reference does anything besides forwarding (with std::fo...
Definition: MissingStdForwardCheck.h:22
clang::tidy::cppcoreguidelines::NarrowingConversionsCheck
Checks for narrowing conversions, e.g: int i = 0; i += 0.1;.
Definition: NarrowingConversionsCheck.h:22
clang::tidy::cppcoreguidelines::NoMallocCheck
This checker is concerned with C-style memory management and suggest modern alternatives to it.
Definition: NoMallocCheck.h:23
clang::tidy::cppcoreguidelines::NoSuspendWithLockCheck
Flag coroutines that suspend while any lock guard is alive.
Definition: NoSuspendWithLockCheck.h:21
clang::tidy::cppcoreguidelines::OwningMemoryCheck
Checks for common use cases for gsl::owner and enforces the unique owner nature of it whenever possib...
Definition: OwningMemoryCheck.h:21
clang::tidy::cppcoreguidelines::PreferMemberInitializerCheck
Finds member initializations in the constructor body which can be placed into the initialization list...
Definition: PreferMemberInitializerCheck.h:21
clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck
This checks that all array subscriptions on static arrays and std::arrays have a constant index and a...
Definition: ProBoundsConstantArrayIndexCheck.h:22
clang::tidy::cppcoreguidelines::ProBoundsPointerArithmeticCheck
Flags all kinds of pointer arithmetic that have result of pointer type, i.e.
Definition: ProBoundsPointerArithmeticCheck.h:22
clang::tidy::cppcoreguidelines::ProTypeConstCastCheck
Imposes limitations on the use of const_cast within C++ code.
Definition: ProTypeConstCastCheck.h:20
clang::tidy::cppcoreguidelines::ProTypeCstyleCastCheck
This check flags all use of C-style casts that perform a static_cast downcast, const_cast,...
Definition: ProTypeCstyleCastCheck.h:21
clang::tidy::cppcoreguidelines::ProTypeStaticCastDowncastCheck
Checks for usages of static_cast, where a base class is downcasted to a derived class.
Definition: ProTypeStaticCastDowncastCheck.h:21
clang::tidy::cppcoreguidelines::ProTypeUnionAccessCheck
This check flags all access to members of unions.
Definition: ProTypeUnionAccessCheck.h:21
clang::tidy::cppcoreguidelines::ProTypeVarargCheck
This check flags all calls to c-style variadic functions and all use of va_arg.
Definition: ProTypeVarargCheck.h:21
clang::tidy::cppcoreguidelines::RvalueReferenceParamNotMovedCheck
Warns when an rvalue reference function parameter is never moved within the function body.
Definition: RvalueReferenceParamNotMovedCheck.h:21
clang::tidy::cppcoreguidelines::SlicingCheck
Flags slicing (incomplete copying of an object's state) of member variables or vtable.
Definition: SlicingCheck.h:25
clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck
Checks for classes where some, but not all, of the special member functions are defined.
Definition: SpecialMemberFunctionsCheck.h:23
clang::tidy::cppcoreguidelines::VirtualClassDestructorCheck
Finds base classes whose destructor is neither public and virtual nor protected and non-virtual.
Definition: VirtualClassDestructorCheck.h:22
clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck
This checker finds classes that not only contain the data (non-static member variables),...
Definition: NonPrivateMemberVariablesInClassesCheck.h:27
clang::tidy::misc::UnconventionalAssignOperatorCheck
Finds declarations of assignment operators with the wrong return and/or argument types and definition...
Definition: UnconventionalAssignOperatorCheck.h:27
clang::tidy::modernize::AvoidCArraysCheck
Find C-style array types and recommend to use std::array<> / std::vector<>.
Definition: AvoidCArraysCheck.h:20
clang::tidy::modernize::MacroToEnumCheck
Replaces groups of related macros with an unscoped anonymous enum.
Definition: MacroToEnumCheck.h:22
clang::tidy::modernize::UseDefaultMemberInitCheck
Convert a default constructor's member initializers into default member initializers.
Definition: UseDefaultMemberInitCheck.h:22
clang::tidy::modernize::UseOverrideCheck
Use C++11's override and remove virtual where applicable.
Definition: UseOverrideCheck.h:17
clang::tidy::performance::NoexceptDestructorCheck
The check flags destructors not marked with noexcept or marked with noexcept(expr) where expr evaluat...
Definition: NoexceptDestructorCheck.h:23
clang::tidy::performance::NoexceptMoveConstructorCheck
The check flags user-defined move constructors and assignment operators not marked with noexcept or m...
Definition: NoexceptMoveConstructorCheck.h:27
clang::tidy::performance::NoexceptSwapCheck
The check flags swap functions not marked with noexcept or marked with noexcept(expr) where expr eval...
Definition: NoexceptSwapCheck.h:23
clang::tidy::readability::MagicNumbersCheck
Detects magic numbers, integer and floating point literals embedded in code.
Definition: MagicNumbersCheck.h:23
clang::tidy::CppCoreGuidelinesModuleAnchorSource
volatile int CppCoreGuidelinesModuleAnchorSource
Definition: CppCoreGuidelinesTidyModule.cpp:159
clang::tidy::ClangTidyOptions
Contains options for clang-tidy.
Definition: ClangTidyOptions.h:49
clang::tidy::ClangTidyOptions::CheckOptions
OptionMap CheckOptions
Key-value mapping used to store check-specific options.
Definition: ClangTidyOptions.h:125
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:122
Generated on Mon Apr 22 2024 04:48:40 for clang-tools by doxygen 1.9.6